Skip to content

Commit

Permalink
used var syntax for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@shubham-eaton
shubham-eaton committed Dec 19, 2024
1 parent 7d7e781 commit ed955b5
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 29 deletions.
24 changes: 12 additions & 12 deletions docs/src/componentDocs/DrawerHeader/markdown/DrawerHeaderAPIDocs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ The `<DrawerHeader>` contains the content at the top of the `<Drawer>`. By defau

<Box>

| Prop Name | Description | Type | Required | Default |
| ----------------- | ---------------------------------------------- | --------------------- | -------- | ---------------------------- |
| Prop Name | Description | Type | Required | Default |
| ----------------- | ---------------------------------------------- | --------------------- | -------- | --------------------------------- |
| backgroundColor | The color used for the background | `string` | no | `theme.vars.palette.primary.main` |
| backgroundImage | An image to display in the header | `string` | no | |
| backgroundOpacity | The opacity of the background image | `number` | no | `0.3` |
| classes | Style overrides | `DrawerHeaderClasses` | no | |
| divider | Optional divider which appears beneath header | `boolean` | no | `false` |
| fontColor | The color of the text elements | `string` | no | dynamic based on background |
| icon | A component to render for the icon | `ReactNode` | no | |
| onIconClick | A function to execute when the icon is clicked | `function` | no | `() => {}` |
| subtitle | The text to show on the second line | `string` | no | |
| title | The text to show on the first line | `string` | no | |
| titleContent | Custom content for header title area | `ReactNode` | no | |
| backgroundImage | An image to display in the header | `string` | no | |
| backgroundOpacity | The opacity of the background image | `number` | no | `0.3` |
| classes | Style overrides | `DrawerHeaderClasses` | no | |
| divider | Optional divider which appears beneath header | `boolean` | no | `false` |
| fontColor | The color of the text elements | `string` | no | dynamic based on background |
| icon | A component to render for the icon | `ReactNode` | no | |
| onIconClick | A function to execute when the icon is clicked | `function` | no | `() => {}` |
| subtitle | The text to show on the second line | `string` | no | |
| title | The text to show on the first line | `string` | no | |
| titleContent | Custom content for header title area | `ReactNode` | no | |

</Box>

Expand Down
26 changes: 13 additions & 13 deletions docs/src/componentDocs/ScoreCard/markdown/ScoreCardAPIDocs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,20 @@ Card component that calls attention to particular values.

<Box>

| Prop Name | Description | Type | Required | Default |
| :-------------------- | :------------------------------------------ | :----------------- | :------- | :--------------------------- |
| actionItems | Icons to show to the right of the text | `JSX.Element[]` | no | |
| actionLimit | Max number of actionItems in the header | `number` | no | 3 |
| actionRow | Component to render for the footer | `JSX.Element` | no | |
| badge | The component to render in the callout area | `JSX.Element` | no | |
| badgeOffset | Vertical offset for the badge component | `number` | no | 0 |
| classes | Style overrides | `ScoreCardClasses` | no | |
| headerBackgroundImage | An image to display in the header | `string` | no | |
| Prop Name | Description | Type | Required | Default |
| :-------------------- | :------------------------------------------ | :----------------- | :------- | :-------------------------------- |
| actionItems | Icons to show to the right of the text | `JSX.Element[]` | no | |
| actionLimit | Max number of actionItems in the header | `number` | no | 3 |
| actionRow | Component to render for the footer | `JSX.Element` | no | |
| badge | The component to render in the callout area | `JSX.Element` | no | |
| badgeOffset | Vertical offset for the badge component | `number` | no | 0 |
| classes | Style overrides | `ScoreCardClasses` | no | |
| headerBackgroundImage | An image to display in the header | `string` | no | |
| headerColor | The color of the header | `string` | no | `theme.vars.palette.primary.main` |
| headerFontColor | The color for text and icons in header | `string` | no | `white` |
| headerInfo | Tertiary text | `string` | no | |
| headerTitle | The primary text | `string` | yes | |
| headerSubtitle | The secondary text | `string` | no | |
| headerFontColor | The color for text and icons in header | `string` | no | `white` |
| headerInfo | Tertiary text | `string` | no | |
| headerTitle | The primary text | `string` | yes | |
| headerSubtitle | The secondary text | `string` | no | |

</Box>

Expand Down
6 changes: 2 additions & 4 deletions docs/src/router/drawer.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,14 @@ export const NavigationDrawer: React.FC = () => {
>
<Typography variant="subtitle1">Brightlayer User Interface</Typography>
<Stack direction={'row'} alignItems={'center'} gap={1}>
<Typography variant={'body2'}>
Developer Docs
</Typography>
<Typography variant={'body2'}>Developer Docs</Typography>
<Chip
sx={{
color: 'primary.main',
backgroundColor: 'white',
...theme.applyStyles('dark', {
color: theme.vars.palette.grey[200],
})
}),
}}
icon={<ReactIcon color={'primary'} />}
label={
Expand Down

0 comments on commit ed955b5

Please sign in to comment.