Skip to content

Commit c66d0a6

Browse files
bruugeyTheSonOfThomp
bruugey
authored and
TheSonOfThomp
committed
Fix typo tables (#1948)
1 parent eb50ba6 commit c66d0a6

File tree

1 file changed

+31
-33
lines changed

1 file changed

+31
-33
lines changed

‎packages/typography/README.md‎

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -127,27 +127,27 @@ All props extend the HTMLElementProps of their root tag, however the below compo
127127

128128
# Body
129129

130-
| Prop | Type | Description | Default |
131-
| -------------- | ----------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------- |
132-
| `weight` | `'regular'`, `'medium'` | font-weight applied to typography element | `'regular'` |
133-
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
134-
| `as` | `keyof JSX.IntrinsicElements` | Element to render the component as. **Note**: This will supersede the behavior of any other props. | `'p'` |
135-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
130+
| Prop | Type | Description | Default |
131+
| -------------- | ----------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------- |
132+
| `weight` | `'regular' | 'medium'` | font-weight applied to typography element | `'regular'` |
133+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
134+
| `as` | `keyof JSX.IntrinsicElements` | Element to render the component as. **Note**: This will supersede the behavior of any other props. | `'p'` |
135+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |
136136

137137
# InlineCode
138138

139-
| Prop | Type | Description | Default |
140-
| -------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------- |
141-
| `href` | `string`, `undefined` | If an `href` prop is passed to `InlineCode` it will be rendered with an `a` tag wrapping the `code` tag. Otherwise, it'll simply render as a `code` tag. | |
142-
| `darkMode` | `boolean` | Determines if the component renders in dark mode |
143-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
139+
| Prop | Type | Description | Default |
140+
| -------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
141+
| `href` | `string \| undefined` | If an `href` prop is passed to `InlineCode` it will be rendered with an `a` tag wrapping the `code` tag. Otherwise, it'll simply render as a `code` tag. | |
142+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | |
143+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |
144144

145145
# InlineKeyCode
146146

147-
| Prop | Type | Description | Default |
148-
| -------------- | --------- | ------------------------------------------------ | --------------------------------------- | -------------------------------------------- |
149-
| `darkMode` | `boolean` | Determines if the component renders in dark mode | |
150-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
147+
| Prop | Type | Description | Default |
148+
| -------------- | ------------ | ------------------------------------------------ | --------------------------------------------- |
149+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | |
150+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |
151151

152152
# Disclaimer
153153

@@ -170,27 +170,25 @@ All props extend the HTMLElementProps of their root tag, however the below compo
170170

171171
# Link
172172

173-
| Prop | Type | Description | Default |
174-
| ------------------ | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------- |
175-
| `arrowAppearance` | `'hover'`, `'persist'`, `'none'` | Displays a right arrow adjacent to the anchor tag. When set to `persist` the arrow will always be present. When set to `hover`, the arrow will only appear when hovering over the arrow. | `'none'` |
176-
| `hideExternalIcon` | `boolean` | Hides the external icon when the current host name is different from the host of the destination URL | `false` |
177-
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
178-
| `as` | `keyof JSX.IntrinsicElements` | Element to render the component as. **Note**: This will supersede the behavior of any other props. | `'a'` |
179-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
180-
181-
_Note:_ If the current host name is different from the host of the destination URL, we will provide the "\_blank" value for the `target` prop. When the target is set to open in a new tab, we render an icon as a visual affordance.
173+
| Prop | Type | Description | Default |
174+
| ------------------ | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
175+
| `arrowAppearance` | `'hover'`, `'persist'`, `'none'` | Displays a right arrow adjacent to the anchor tag. When set to `persist` the arrow will always be present. When set to `hover`, the arrow will only appear when hovering over the arrow. | `'none'` |
176+
| `hideExternalIcon` | `boolean` | Hides the external icon when the current host name is different from the host of the destination URL | `false` |
177+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
178+
| `as` | `keyof JSX.IntrinsicElements` | Element to render the component as. **Note**: This will supersede the behavior of any other props. | `'a'` |
179+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |
182180

183181
# Label
184182

185-
| Prop | Type | Description | Default |
186-
| -------------- | --------- | ------------------------------------------------------- | --------------------------------------- | -------------------------------------------- |
187-
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
188-
| `disabled` | `boolean` | Determines whether the component should appear disabled | `false` |
189-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
183+
| Prop | Type | Description | Default |
184+
| -------------- | ------------ | ------------------------------------------------------- | --------------------------------------------- |
185+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
186+
| `disabled` | `boolean` | Determines whether the component should appear disabled | `false` |
187+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |
190188

191189
# Description
192190

193-
| Prop | Type | Description | Default |
194-
| -------------- | --------- | ------------------------------------------------ | --------------------------------------- | -------------------------------------------- |
195-
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
196-
| `baseFontSize` | `13 | 16` | font-size applied to typography element | default to value set by LeafyGreen Provider. |
191+
| Prop | Type | Description | Default |
192+
| -------------- | ------------ | ------------------------------------------------ | --------------------------------------------- |
193+
| `darkMode` | `boolean` | Determines if the component renders in dark mode | `false` |
194+
| `baseFontSize` | `13` \| `16` | font-size applied to typography element | Defaults to value set by LeafyGreen Provider. |

0 commit comments

Comments
 (0)