Skip to content
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.

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

divides accordion and accordion item readme #26938

Conversation

brianchristopherbrady
Copy link
Contributor

Divides Accordion and Accordion Item docs into two separate README

@fabricteam
Copy link
Collaborator

fabricteam commented Feb 21, 2023

📊 Bundle size report

🤖 This report was generated against 237267b5ad816d090011c93f2922476c1abfe87f

@size-auditor
Copy link

size-auditor bot commented Feb 21, 2023

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: 237267b5ad816d090011c93f2922476c1abfe87f (build)

@codesandbox-ci
Copy link

codesandbox-ci bot commented Feb 21, 2023

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 9473f5d:

Sandbox Source
@fluentui/react 8 starter Configuration
@fluentui/react-components 9 starter Configuration

Copy link
Member

@miroslavstastny miroslavstastny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the WC3 vs FUIR9 comparison!

**Property Mapping**
| Fluent UI React 9 | Fluent Web Components 3 | Description of difference |
|---------------------------|---------------------------|------------------------------------------------------------------------------------------|
| `defaultOpenItems: number`| `expand: boolean` | _FuiR9_ `defaultOpenItems` is a number property set on the `Accordion` corresponding to the intended `AccordionItem` to be expanded.<hr /> `expand` is a boolean property set directly on the `AccordionItem` intended to be expanded.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would expect defaultOpenItems to be documented both here in accordion-item and in accordion as well.

| Fluent UI React 9 | Fluent Web Components 3 | Description of difference |
|---------------------------|---------------------------|------------------------------------------------------------------------------------------|
| `defaultOpenItems: number`| `expand: boolean` | _FuiR9_ `defaultOpenItems` is a number property set on the `Accordion` corresponding to the intended `AccordionItem` to be expanded.<hr /> `expand` is a boolean property set directly on the `AccordionItem` intended to be expanded.
| `multiple: boolean` | `expandmode: "single"` &#124; `"multiple"`| |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be moved to accordion.

Suggested change
| `multiple: boolean` | `expandmode: "single"` &#124; `"multiple"`| |
| `multiple: boolean` | `expand-mode: "single"` &#124; `"multiple"`| |

| `size` | `size` |
| `as: 'h1'` &#124; `'h2'` &#124; `'h3'` &#124; `'h4'` &#124; `'h5'` &#124; `'h6'` | `headinglevel: 1` &#124; `2` &#124; `3` &#124; `4` &#124; `5` &#124; `6` | `as` property sets a wrapper around the `AccordionItem` header with the corresponding header tag ( `h1`, `h2`, etc. ) <hr /> `headinglevel` sets the `aria-level` attribute to the corresponding heading level.
| `disabled` | `disabled` |
| `expandIconPosition` | `expandIconPosition` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `expandIconPosition` | `expandIconPosition` |
| `expandIconPosition` | `expand-icon-position` |

@brianchristopherbrady brianchristopherbrady merged commit c0d4b0d into web-components-v3 Feb 27, 2023
@khmakoto khmakoto deleted the user/brianbrady/webComponentAccordionDocsFix branch April 6, 2023 00:11
chrisdholt pushed a commit that referenced this pull request Apr 29, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit to radium-v/fluentui that referenced this pull request Apr 29, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit to radium-v/fluentui that referenced this pull request Apr 29, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit to radium-v/fluentui that referenced this pull request Apr 30, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request Apr 30, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 2, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 2, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 2, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 3, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 6, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 6, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 8, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
radium-v pushed a commit that referenced this pull request May 10, 2024
* divides accordion and accordion item readme

* updates accordion docs

* updates accordion docs

* formats docs table

* yarn change
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants