docs: Add UNSAFE documentation to mobile Button and Text #2392

taylorvnoj · 2025-02-21T02:22:15Z

Motivations

Recently we added UNSAFE_ props to mobile Text & Button.

UNSAFE_ was going to be used by a team and was somewhat time sensitive, so I committed to updating docs as a fast follow, to get the feature out the door.

Changes

Added

New Text Implement tab with UNSAFE_ info
UNSAFE_ info to the pre-existing Button Implement tab

Testing

Make sure you see UNSAFE_ info in the Implement tab for Button & Text.

Changes can be
tested via Pre-release

In Atlantis we use Github's built in pull request reviews.

cloudflare-workers-and-pages · 2025-02-21T02:22:48Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`794c005`
Status:	✅ Deploy successful!
Preview URL:	https://8e8b3efe.atlantis.pages.dev
Branch Preview URL:	https://taylor-docs-for-unsafe.atlantis.pages.dev

View logs

cloudflare-workers-and-pages · 2025-02-21T02:24:13Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`d463e1c`
Status:	⚡️ Build in progress...

View logs

cloudflare-workers-and-pages · 2025-02-21T02:26:49Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`171cb51`
Status:	✅ Deploy successful!
Preview URL:	https://ae6c297f.atlantis.pages.dev
Branch Preview URL:	https://taylor-docs-for-unsafe.atlantis.pages.dev

View logs

cloudflare-workers-and-pages · 2025-02-21T02:27:55Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`c975ab4`
Status:	✅ Deploy successful!
Preview URL:	https://d54410d5.atlantis.pages.dev
Branch Preview URL:	https://taylor-docs-for-unsafe.atlantis.pages.dev

View logs

cloudflare-workers-and-pages · 2025-02-21T02:29:08Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`d463e1c`
Status:	✅ Deploy successful!
Preview URL:	https://529b74e7.atlantis.pages.dev
Branch Preview URL:	https://taylor-docs-for-unsafe.atlantis.pages.dev

View logs

…t, Popover

cloudflare-workers-and-pages · 2025-02-21T04:36:13Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`f57feaa`
Status:	⚡️ Build in progress...

View logs

cloudflare-workers-and-pages · 2025-02-21T04:41:16Z

Deploying atlantis with Cloudflare Pages

Latest commit:	`f57feaa`
Status:	✅ Deploy successful!
Preview URL:	https://b291b67b.atlantis.pages.dev
Branch Preview URL:	https://taylor-docs-for-unsafe.atlantis.pages.dev

View logs

taylorvnoj · 2025-02-21T04:41:48Z

docs/components/Text/Text.stories.mdx

@@ -199,17 +199,3 @@ provided.
 <Canvas>
  <Text size="small">What is this, a font for 🐜s?</Text>
 </Canvas>
-
-## Platform Considerations (Mobile)


Now in TextNotes.mdx

taylorvnoj · 2025-02-21T04:42:46Z

packages/components-native/src/Button/Button.tsx

@@ -81,7 +81,7 @@ interface CommonButtonProps {
  /**
   * **Use at your own risk:** Custom style for specific elements. This should only be used as a
   * **last resort**. Using this may result in unexpected side effects.
-   * More information [here](https://atlantis.getjobber.com/storybook/?path=/docs/guides-customizing-components--docs#unsafe_-props).
+   * More information in the Customizing components Guide.


decided to do this instead of:

Linking back to Storybook

Links don't show up in the prop table on new docs anyway

nad182 · 2025-02-24T19:39:16Z

packages/components-native/src/Button/Button.tsx

@@ -81,7 +81,7 @@ interface CommonButtonProps {
  /**
   * **Use at your own risk:** Custom style for specific elements. This should only be used as a
   * **last resort**. Using this may result in unexpected side effects.
-   * More information [here](https://atlantis.getjobber.com/storybook/?path=/docs/guides-customizing-components--docs#unsafe_-props).
+   * More information in the Customizing components Guide.


I think it would still be valuable to add the link in case the doc is viewed in Storybook.

Suggested change

* More information in the Customizing components Guide.

* More information in the [Customizing components Guide](https://atlantis.getjobber.com/guides/customizing-components).

However, a more general question, should I be seeing UNSAFE_ prop docs on component pages on the new site? Because I don't see them for Button or Text on the new docs site.

Ok that's fair - I brought the links back in Text and Button (and Popover)

It's strange you don't see the UNSAFE_ props, because they are on prod (since these props were added previous to this PR)

and here it is on local:

Should it be visible only in "Mobile" tab?

Yup - since UNSAFE is only in the Text and Button mobile components right now, it'll only be visible in the mobile tab

packages/site/src/content/Text/TextNotes.mdx

Co-authored-by: Nazarii L <[email protected]>

nad182

A small suggestion to still include the links (in case the docs are viewed in Storybook) as well as a typo fix suggestion.

nad182 · 2025-02-24T20:08:04Z

packages/components/src/Popover/Popover.tsx

@@ -48,7 +48,7 @@ export interface PopoverProps {
  /**
   * **Use at your own risk:** Custom style for specific elements. This should only be used as a
   * **last resort**. Using this may result in unexpected side effects.
-   * More information [here](https://atlantis.getjobber.com/storybook/?path=/docs/guides-customizing-components--docs#unsafe_-props).
+   * More information in the Customizing components Guide.


Perhaps, a link here and on line 40?

Done here f1c32aa

nad182 · 2025-02-24T20:10:58Z

packages/components/src/Popover/Popover.tsx

@@ -37,7 +37,7 @@ export interface PopoverProps {
  /**
   * **Use at your own risk:** Custom class names for specific elements. This should only be used as a
   * **last resort**. Using this may result in unexpected side effects.
-   * More information [here](https://atlantis.getjobber.com/storybook/?path=/docs/guides-customizing-components--docs#unsafe_-props).
+   * More information in the Customizing components Guide.


This line =).

Done here 794c005

nad182

Looks good!

taylorvnoj added 2 commits February 19, 2025 12:10

start to update Button Docs regarding UNSAFE in mobile component

e9f4c63

update Button Implement tab with UNSAFE info

171cb51

taylorvnoj self-assigned this Feb 21, 2025

Merge branch 'master' into TAYLOR/docs-for-unsafe

c975ab4

remove UNSAFE example from mobile Button story

d463e1c

taylorvnoj added 3 commits February 20, 2025 23:13

add Text Implement tab with UNSAFE docs

1c53299

update prop description to no longer link to storybook

4be4d1d

update prop description to no longer link to storybook in Button, Tex…

f57feaa

…t, Popover

taylorvnoj commented Feb 21, 2025

View reviewed changes

taylorvnoj marked this pull request as ready for review February 21, 2025 04:53

taylorvnoj requested a review from a team as a code owner February 21, 2025 04:53

jobbiebot bot added review requested Team UX Foundations labels Feb 21, 2025

show inline styles example

c17e5a6

nad182 reviewed Feb 24, 2025

View reviewed changes

packages/site/src/content/Text/TextNotes.mdx Outdated Show resolved Hide resolved

reference correct component

b8ab074

Co-authored-by: Nazarii L <[email protected]>

nad182 requested changes Feb 24, 2025

View reviewed changes

jobbiebot bot added changes requested and removed review requested labels Feb 24, 2025

taylorvnoj added 2 commits February 24, 2025 14:59

re add links to prop description

5943103

update prop description

a9f4ed4

nad182 reviewed Feb 24, 2025

View reviewed changes

update Popover UNSAFE prop description

f1c32aa

nad182 reviewed Feb 24, 2025

View reviewed changes

update UNSAFE_classname in popover

794c005

nad182 approved these changes Feb 24, 2025

View reviewed changes

jobbiebot bot added approved and removed changes requested labels Feb 24, 2025

taylorvnoj merged commit a53fc34 into master Feb 24, 2025
12 checks passed

taylorvnoj deleted the TAYLOR/docs-for-unsafe branch February 24, 2025 20:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add UNSAFE documentation to mobile Button and Text #2392

docs: Add UNSAFE documentation to mobile Button and Text #2392

taylorvnoj commented Feb 21, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 21, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 21, 2025

cloudflare-workers-and-pages bot commented Feb 21, 2025

cloudflare-workers-and-pages bot commented Feb 21, 2025

cloudflare-workers-and-pages bot commented Feb 21, 2025

cloudflare-workers-and-pages bot commented Feb 21, 2025

cloudflare-workers-and-pages bot commented Feb 21, 2025

taylorvnoj Feb 21, 2025

taylorvnoj Feb 21, 2025

nad182 Feb 24, 2025

taylorvnoj Feb 24, 2025 •

edited

Loading

nad182 Feb 24, 2025

taylorvnoj Feb 24, 2025

nad182 left a comment

nad182 Feb 24, 2025

taylorvnoj Feb 24, 2025

nad182 Feb 24, 2025

taylorvnoj Feb 24, 2025

nad182 left a comment

	* More information in the Customizing components Guide.
	* More information in the [Customizing components Guide](https://atlantis.getjobber.com/guides/customizing-components).

docs: Add UNSAFE documentation to mobile Button and Text #2392

docs: Add UNSAFE documentation to mobile Button and Text #2392

Conversation

taylorvnoj commented Feb 21, 2025 • edited Loading

Motivations

Changes

Added

Testing

cloudflare-workers-and-pages bot commented Feb 21, 2025 • edited Loading

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

cloudflare-workers-and-pages bot commented Feb 21, 2025

Deploying atlantis with Cloudflare Pages

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taylorvnoj Feb 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nad182 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nad182 left a comment

Choose a reason for hiding this comment

taylorvnoj commented Feb 21, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 21, 2025 •

edited

Loading

taylorvnoj Feb 24, 2025 •

edited

Loading