-
-
Notifications
You must be signed in to change notification settings - Fork 971
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace current theme components with
@swmansion/t-rex-ui (#2906)
## Description Because of a ramping up maintainance cost across our suite of tools - Reanimated, Gesture Handler & React Native IDE we've decided to create a UI library for our reusable docusaurus components. This PR replaces old theme components such as Admonition, Sidebar and Table of Contents with new, reusable ones from `@swmansion/t-rex-ui`. Full list of replaced components: * Admonition * PaginatorNavLink * DocSidebar * DocSidebarItem * DocSidebarItems * DocCard * DocItemTOCMobile * DocItemMetadata * TOCCollapsible * TOCItems * TOCItemTree * Footer * Navbar * SearchPage SearchPage was also replaced, but this PR is held by incoming @swmansion/t-rex-ui patch with SearchPage export. ## Test plan ``` cd docs/ yarn # to test development build yarn start # to test production build yarn build yarn serve ```
- Loading branch information
1 parent
3736acb
commit 1fdd82c
Showing
54 changed files
with
88 additions
and
2,742 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,3 @@ | ||
| import React from 'react'; | ||
| import clsx from 'clsx'; | ||
| import { ThemeClassNames } from '@docusaurus/theme-common'; | ||
| import Translate from '@docusaurus/Translate'; | ||
| import ThemedImage from '@theme/ThemedImage'; | ||
| import styles from './styles.module.css'; | ||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
| import { Admonition } from '@swmansion/t-rex-ui'; | ||
|
|
||
| const AdmonitionConfigs = { | ||
| note: { | ||
| infimaClassName: 'secondary', | ||
| label: ( | ||
| <Translate | ||
| id="theme.admonition.note" | ||
| description="The default label used for the Note admonition (:::note)"> | ||
| note | ||
| </Translate> | ||
| ), | ||
| }, | ||
| tip: { | ||
| infimaClassName: 'success', | ||
| label: ( | ||
| <Translate | ||
| id="theme.admonition.tip" | ||
| description="The default label used for the Tip admonition (:::tip)"> | ||
| tip | ||
| </Translate> | ||
| ), | ||
| }, | ||
| danger: { | ||
| infimaClassName: 'danger', | ||
| label: ( | ||
| <Translate | ||
| id="theme.admonition.danger" | ||
| description="The default label used for the Danger admonition (:::danger)"> | ||
| danger | ||
| </Translate> | ||
| ), | ||
| }, | ||
| info: { | ||
| infimaClassName: 'info', | ||
| label: ( | ||
| <Translate | ||
| id="theme.admonition.info" | ||
| description="The default label used for the Info admonition (:::info)"> | ||
| info | ||
| </Translate> | ||
| ), | ||
| }, | ||
| caution: { | ||
| infimaClassName: 'caution', | ||
| label: ( | ||
| <Translate | ||
| id="theme.admonition.caution" | ||
| description="The default label used for the Caution admonition (:::caution)"> | ||
| caution | ||
| </Translate> | ||
| ), | ||
| }, | ||
| }; | ||
| // Legacy aliases, undocumented but kept for retro-compatibility | ||
| const aliases = { | ||
| secondary: 'note', | ||
| important: 'info', | ||
| success: 'tip', | ||
| warning: 'danger', | ||
| }; | ||
|
|
||
| export default function Admonition(props) { | ||
| const { | ||
| children, | ||
| type, | ||
| title, | ||
| icon: iconProp, | ||
| } = processAdmonitionProps(props); | ||
| const typeConfig = getAdmonitionConfig(type); | ||
| const titleLabel = title ?? typeConfig.label; | ||
|
|
||
| const dangerIcon = { | ||
| light: useBaseUrl('/img/danger.svg'), | ||
| dark: useBaseUrl('/img/danger-dark.svg'), | ||
| }; | ||
|
|
||
| return ( | ||
| <div | ||
| className={clsx( | ||
| ThemeClassNames.common.admonition, | ||
| ThemeClassNames.common.admonitionType(props.type), | ||
| styles.admonition, | ||
| 'alert', | ||
| styles[`alert--${typeConfig.infimaClassName}`] | ||
| )}> | ||
| <div className={styles.admonitionHeading}> | ||
| <div className={styles.admonitionIcon}> | ||
| <ThemedImage sources={dangerIcon} /> | ||
| </div> | ||
|
|
||
| {titleLabel} | ||
| </div> | ||
| <div className={styles.admonitionContent}>{children}</div> | ||
| </div> | ||
| ); | ||
|
|
||
| function getAdmonitionConfig(unsafeType) { | ||
| const type = aliases[unsafeType] ?? unsafeType; | ||
| const config = AdmonitionConfigs[type]; | ||
| if (config) { | ||
| return config; | ||
| } | ||
| console.warn( | ||
| `No admonition config found for admonition type "${type}". Using Info as fallback.` | ||
| ); | ||
| return AdmonitionConfigs.info; | ||
| } | ||
| } | ||
|
|
||
| // Workaround because it's difficult in MDX v1 to provide a MDX title as props | ||
| // See https://github.com/facebook/docusaurus/pull/7152#issuecomment-1145779682 | ||
| function extractMDXAdmonitionTitle(children) { | ||
| const items = React.Children.toArray(children); | ||
| const mdxAdmonitionTitle = items.find( | ||
| (item) => | ||
| React.isValidElement(item) && item.props?.mdxType === 'mdxAdmonitionTitle' | ||
| ); | ||
| const rest = <>{items.filter((item) => item !== mdxAdmonitionTitle)}</>; | ||
| return { | ||
| mdxAdmonitionTitle, | ||
| rest, | ||
| }; | ||
| } | ||
|
|
||
| function processAdmonitionProps(props) { | ||
| const { mdxAdmonitionTitle, rest } = extractMDXAdmonitionTitle( | ||
| props.children | ||
| ); | ||
| return { | ||
| ...props, | ||
| title: props.title ?? mdxAdmonitionTitle, | ||
| children: rest, | ||
| }; | ||
| } | ||
| export default Admonition; |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.