Update side navigation guidance for disableTopBarBehaviour prop
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 79
- Forks
- 52
- Avg merge
- 18h 58m
- Merged PRs (30d)
- 4
Description
## What component is this related to?
Side navigation
## Why do we need it?
This [ticket in the ui kit ](https://github.com/mi6/ic-ui-kit/issues/892) has been completed to add a prop to stop side navigation moving to the top on small devices.
Guidance needs to be added to explain that we recommend using the default side navigation behaviour where it does move to the top on small devices, and that this should only be used in specific use cases.
Also need to add code example.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the side navigation guidance and its existing examples, then review the completed UI kit ticket linked in the issue for the disableTopBarBehaviour prop. Done means the guidance recommends the default small-device behavior, explains when the prop is appropriate, and includes a code example.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100