microsoft / microsoft/fluentui

[Bug]: display issues for slot props in Storybook

Open
#27,908 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area: Build System Area: Documentation Fluent UI react-components (v9) Resolution: Soft Close Storybook
Dominant language
TypeScript
Stars
20.3k
Forks
2.9k
Avg merge
2d 9h
Merged PRs (30d)
46

Description

Library

React Components / v9 (@fluentui/react-components)

System Info
https://react.fluentui.dev/?path=/docs/components-dropdown--default
Are you reporting Accessibility issue?

None

Reproduction

https://react.fluentui.dev/?path=/docs/components-dropdown--default

Bug Description

Actual Behavior

Screen Shot 2023-05-18 at 11 00 43 PM The first 4 props aren't correctly formatted. For example, it is unclear whether the prop `expandIcon` is a boolean or an actual React element.

Expected Behavior

The 4 props shown in the screenshot should be written in English sentences.

Logs

No response

Requested priority

Normal

Products/sites affected

No response

Are you willing to submit a PR to fix?

no

Validations
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
  • The provided reproduction is a minimal reproducible example of the bug.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the React Components / v9 Storybook reproduction at https://react.fluentui.dev/?path=/docs/components-dropdown--default and inspect how the Dropdown story renders its slot props. Compare the first four displayed props with the screenshot; done means each is formatted as an English sentence that makes values such as expandIcon's expected type clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, storybook, typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.