diff --git a/packages/side-nav/README.md b/packages/side-nav/README.md index b5ef1853a9..6c432d5359 100644 --- a/packages/side-nav/README.md +++ b/packages/side-nav/README.md @@ -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.
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.
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.
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.
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._