Skip to content

Update description for as prop in side nav readme #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2020
Merged

Update description for as prop in side nav readme #411

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
578335a
update description for "as" prop
khelif96 May 6, 2020
f531234
run formatting script
May 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/side-nav/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,15 +169,15 @@ _Any other properties will be spread on the root-level element._

## Properties

| Prop | Type | Description | Default |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `active` | `boolean` | Whether or not the component should be rendered in an active state. | `false` |
| `disabled` | `boolean` | Whether or not the component should be rendered in a disabled state. | `false` |
| `ariaCurrentValue` | `enum` | The aria-current attribute value set when the component is active.<br/>See the [WAI-ARIA 1.1 spec](https://www.w3.org/TR/wai-aria-1.1/#aria-current 'WAI-ARIA 1.1 Spec') for a list of accepted values. | `'page'` |
| `className` | `string` | Class name that will be applied to the component's header. | `undefined` |
| `children` | `node` | Content that will be rendered inside the root-level element. | `undefined` |
| `href` | `string` | When provided, the component will be rendered as an anchor element. | `undefined` |
| `as` | `string` | When provided, the component will be rendered as the component or html tag indicated by this prop. <br/>Other additional props will be spread on the anchor element. | `undefined` |
| Prop | Type | Description | Default |
| ------------------ | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `active` | `boolean` | Whether or not the component should be rendered in an active state. | `false` |
| `disabled` | `boolean` | Whether or not the component should be rendered in a disabled state. | `false` |
| `ariaCurrentValue` | `enum` | The aria-current attribute value set when the component is active.<br/>See the [WAI-ARIA 1.1 spec](https://www.w3.org/TR/wai-aria-1.1/#aria-current 'WAI-ARIA 1.1 Spec') for a list of accepted values. | `'page'` |
| `className` | `string` | Class name that will be applied to the component's header. | `undefined` |
| `children` | `node` | Content that will be rendered inside the root-level element. | `undefined` |
| `href` | `string` | When provided, the component will be rendered as an anchor element. | `undefined` |
| `as` | `HTML Tag` or `React Element` | When provided, the component will be rendered as the component or html tag indicated by this prop. <br/>Other additional props will be spread on the anchor element. For example, `Link` or `a` tags can be supplied to replace `button` from being the DOM element that wraps the component. | `undefined` |

_When `href` is set, `href` and any additional props will be spread on the anchor element._

Expand Down