influxdata / influxdata/clockface
Fix Storybook documentation error
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46
- Forks
- 18
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 1
Description
In "[Toggle](https://influxdata.github.io/clockface/?path=/story/components-inputs-base--toggle&knob-Label:%20text=I%20Agree%20to%20Terms%20and%20Conditions&knob-Label:%20wrapText=true&knob-Parent%20Width%20(px)=300&knob-checked=true&knob-color=Primary&knob-disabledTitleText=Disabled%20Title%20Text&knob-fill=None&knob-icon=None&knob-id=example_toggle_id&knob-name=Name&knob-size=Small&knob-status=Default&knob-style={}&knob-tabIndex=1&knob-titleText=Title%20Text&knob-type=Radio&knob-value=Value%20Text)", the import line reads:
`import {Toggle, ToggleInputType} from '@influxdata/clockface'`
However, it's actually called "InputToggleType", not ToggleInputType.
Update the Storybook documentation to use the correct name.
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
Open the linked Toggle Storybook documentation and locate the import example containing ToggleInputType. Update it to use InputToggleType, then run or preview Storybook to confirm the example displays the correct import name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, storybook, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100