Skip to content

Commit

Permalink
feat(docs): add warning to customization docs for twilio employees (#…
Browse files Browse the repository at this point in the history
…3940)

* feat(docs): add warning to customization docs for twilio employees

* fix: add anchor import

* chore: add space before anchor

* feat: add info about ThemeProvider

* chore: add inlinecode import
  • Loading branch information
serifluous authored Jun 18, 2024
1 parent ccabf8d commit 52b8bad
Showing 1 changed file with 17 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ export const meta = {
slug: '/customization/customization-provider/',
};

import {PageHeaderSeparator} from '@twilio-paste/page-header'
import {Separator} from '@twilio-paste/separator'
import {PageHeaderSeparator} from '@twilio-paste/page-header';
import {Anchor} from '@twilio-paste/anchor';
import {Separator} from '@twilio-paste/separator';
import {Callout} from '@twilio-paste/callout';
import {InlineCode} from '@twilio-paste/inline-code';
import PackageJSON from '@twilio-paste/customization/package.json';
import Changelog from '@twilio-paste/customization/CHANGELOG.md';
import {ThemeObjectDisplay} from '../../components/ThemeObjectDisplay';
Expand Down Expand Up @@ -45,9 +48,18 @@ export const getStaticProps = async () => {

<content>

The `CustomizationProvider` provides a central place for customizations to be applied to an application that is using Paste.

Say you want to build a web application or website using Paste, but want to have your own look and feel—the `CustomizationProvider` exists to do just that.
<Callout variant="warning" marginY="space70">
<CalloutHeading as="h2">This page is not for Twilio employees!</CalloutHeading>
<CalloutText>
If you're a Twilio employee, check out{' '}
<Anchor href="/customization/composing-custom-components-with-design-tokens">
How to build custom UI with Paste tokens and primitives
</Anchor>{' '}
to learn how and when to build custom components in a Twilio feature. You should not use <InlineCode>CustomizationProvider</InlineCode> inside <InlineCode>ThemeProvider</InlineCode>, and it likely won't give you the styles you expect. Customization Provider only accepts base themes of <InlineCode>default</InlineCode> and <InlineCode>dark</InlineCode> for Twilio customers to use.
</CalloutText>
</Callout>

The `CustomizationProvider` provides a central place for customizations to be applied to an application using Paste. If you want to build a web application or website using Paste, but want to have your own look and feel—the `CustomizationProvider` exists to do just that.

If you&rsquo;re a Flex customer, and want to build a Flex plugin that follows your brand guidelines, the `CustomizationProvider` can be used for that as well.

Expand Down

0 comments on commit 52b8bad

Please sign in to comment.