From 4359178f7a1dde8d6efcc83cba738a95da32d024 Mon Sep 17 00:00:00 2001 From: James Date: Thu, 1 Jul 2021 14:45:31 -0400 Subject: [PATCH] docs: scss reusability --- docs/admin/components.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/admin/components.mdx b/docs/admin/components.mdx index 9dd683d3be..95aadf323e 100644 --- a/docs/admin/components.mdx +++ b/docs/admin/components.mdx @@ -108,5 +108,11 @@ const CustomTextField = ({ path }) => { ``` ### Styling Custom Components -To maintain a consistent look in your admin UI you may wish to import styles and make use -By importing Payload styles directly and making use of rem for sizing, the UI elements we are adding will not standout and look unfamiliar to our admin panel users. + +Payload exports its SCSS variables and mixins for reuse in your own custom components. This is helpful in cases where you might want to style a custom input similarly to Payload's built-ini styling so it blends more thoroughly into the existing admin UI. + +To make use of Payload SCSS variables / mixins to use directly in your own components, you can import them as follows: + +``` +@import '~payload/scss'; +```