Skip to content

Commit

Permalink
Headline: Update prop descriptions (#1826)
Browse files Browse the repository at this point in the history
Co-authored-by: Noah Overcash <[email protected]>
  • Loading branch information
JohnC-80 and ncovercash authored Jun 14, 2022
1 parent cec7c40 commit 2ca8b66
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lib/Headline/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ Renders headlines in different sizes and with different tags, margins and styles
### Props
Name | Type | Description | Options | Default
--- | --- | --- | --- | ---
children | node | Alternative way to set the label of the headline | | |
children | node | The label of the headline | | |
size | string | The size of the headline | xx-small, x-small, small, medium, large, x-large, xx-large | medium
margin | string | The bottom margin of the component. Automatically matches the size-prop. | xx-small, x-small, small, medium, large, x-large, xx-large, none | medium
tag | string | The tag of the headline | h1, h2, h3, h4, h5, h6, p, div, legend | div
faded | boolean | Adds faded style to headline (gray color) | true/false | false
weight | string | Changes the font-weight of the `<Headline>` | regular, medium, bold, black | bold
block | boolean | If the headline should have `display: block` applied | true/false | false
flex | boolean | If the headline should have `display: flex` applied | true/false | false
className | string | Any custom class(es) which should be added to the Headline | | `""`

0 comments on commit 2ca8b66

Please sign in to comment.