Skip to content

Change names of AccordionItemTitle and AccordionItemBody #154

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 16, 2019
Merged

Change names of AccordionItemTitle and AccordionItemBody #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1f9d0a
Change AccordionItemTitle to AccordionItemHeading and AccordionItemBo…
Jan 16, 2019
5e0ef6c
Revert changelog.md changes to reflect names of components when chang…
Jan 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import ReactDOM from 'react-dom';
import {
Accordion,
AccordionItem,
AccordionItemTitle,
AccordionItemBody,
AccordionItemHeading,
AccordionItemPanel,
} from 'react-accessible-accordion';

// Demo styles, see 'Styles' section below for some notes on use.
Expand All @@ -33,21 +33,21 @@ import 'react-accessible-accordion/dist/fancy-example.css';
const Example = () => (
<Accordion>
<AccordionItem>
<AccordionItemTitle>
<AccordionItemHeading>
<h3>Simple title</h3>
</AccordionItemTitle>
<AccordionItemBody>
</AccordionItemHeading>
<AccordionItemPanel>
<p>Body content</p>
</AccordionItemBody>
</AccordionItemPanel>
</AccordionItem>
<AccordionItem>
<AccordionItemTitle>
<AccordionItemHeading>
<h3>Complex title</h3>
<div>With a bit of description</div>
</AccordionItemTitle>
<AccordionItemBody>
</AccordionItemHeading>
<AccordionItemPanel>
<p>Body content</p>
</AccordionItemBody>
</AccordionItemPanel>
</AccordionItem>
</Accordion>
);
Expand Down Expand Up @@ -147,7 +147,7 @@ We recommend that you copy them into your own app and modify them to suit your n
</tbody>
</table>

### AccordionItemTitle
### AccordionItemHeading

#### props:

Expand All @@ -164,7 +164,7 @@ We recommend that you copy them into your own app and modify them to suit your n
<tr>
<td>className</td>
<td>String</td>
<td>accordion__title</td>
<td>accordion__heading</td>
<td>CSS class(es) applied to the component</td>
</tr>
<tr>
Expand All @@ -176,7 +176,7 @@ We recommend that you copy them into your own app and modify them to suit your n
</tbody>
</table>

### AccordionItemBody
### AccordionItemPanel

#### props:

Expand All @@ -193,13 +193,13 @@ We recommend that you copy them into your own app and modify them to suit your n
<tr>
<td>className</td>
<td>String</td>
<td>accordion__body</td>
<td>accordion__panel</td>
<td>CSS class(es) applied to the component</td>
</tr>
<tr>
<td>hideBodyClassName</td>
<td>String</td>
<td>accordion__body--hidden</td>
<td>accordion__panel--hidden</td>
<td>Class name for hidden body state</td>
</tr>
</tbody>
Expand Down Expand Up @@ -232,8 +232,8 @@ For this type of Accordion, you will get the following `role` set up on your ele

- Accordion: `tablist`
- AccordionItem: no specific role
- AccordionItemTitle: `tab`
- AccordionItemBody: `tabpanel`
- AccordionItemHeading: `tab`
- AccordionItemPanel: `tabpanel`

#### Multiple items

Expand All @@ -243,8 +243,8 @@ For this type of Accordion, you will get the following `role` set up on your ele

- Accordion: no specific role
- AccordionItem: no specific role
- AccordionItemTitle: `button`
- AccordionItemBody: no specific role
- AccordionItemHeading: `button`
- AccordionItemPanel: no specific role

# Browser support

Expand Down
Loading