Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 18, 2024
Merged

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

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba9c5f5
feat(docs): add warning to customization docs for twilio employees
serifluous Jun 13, 2024
3dde5f6
fix: add anchor import
serifluous Jun 13, 2024
752067f
chore: add space before anchor
serifluous Jun 13, 2024
5151e33
feat: add info about ThemeProvider
serifluous Jun 14, 2024
8406e82
chore: add inlinecode import
serifluous Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions packages/paste-website/src/pages/customization/customization-provider.mdx
View file
Open in desktop
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
Loading