Skip to content

Commit 9b8e6dc

Browse files
authored
Update README.md
1 parent 6b60f36 commit 9b8e6dc

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -117,28 +117,23 @@ If your `A11y` component has the `role="button"`, you can use three more props:
117117

118118
#### `content`
119119

120-
`cursor: default`
121-
This role is meant to provide information to screen readers or to serve as a step for a user to navigate your site using Tab for instance.
122-
It's not meant to trigger anything on click or to be activable with the Keyboard.
123-
Therefore it won't show a pointer cursor on hover.
120+
Uses `cursor: default`.
121+
122+
This role is meant to provide information to screen readers or to serve as a step for a user to navigate your site using Tab for instance. It's not meant to trigger anything on click or to be activable with the Keyboard. Therefore it won't show a pointer cursor on hover.
124123

125124
#### `button`
126125

127-
`cursor: pointer`
128-
Special attributes : activationMsg, deactivationMsg, pressedDescription
129-
This role is meant to emulate the behaviour of a button or a togglable button.
130-
It will display a cursor pointer when your cursor is over the linked 3D object.
131-
It will call a function on click but also on any kind of action that would trigger a focused button ( Enter, Double-Tap .. )
132-
It is also actionnable by user using a screen reader.
126+
Uses `cursor: pointer`. Special attributes: activationMsg, deactivationMsg, pressedDescription
127+
128+
This role is meant to emulate the behaviour of a button or a togglable button. It will display a cursor pointer when your cursor is over the linked 3D object. It will call a function on click but also on any kind of action that would trigger a focused button (Enter, Double-Tap, ...). It is also actionnable by user using a screen reader.
129+
133130
You can turn it into a button with aria-pressed by providing the following properties deactivationMsg, pressedDescription in addition to the usual description and activationMsg properties.
134131

135132
#### `link`
136133

137-
`cursor: pointer`
138-
`special attributes : href`
139-
This role is meant to emulate the behaviour of a regular html link.
140-
It should be used in combination with something that will trigger navigation on click.
141-
Just like the button one, it is accessible to all kind of user.
134+
Uses `cursor: pointer`. Special attributes: href.
135+
136+
This role is meant to emulate the behaviour of a regular html link. It should be used in combination with something that will trigger navigation on click. Just like the button one, it is accessible to all kind of user.
142137

143138
```diff
144139
- Don't forget to provide the href attribute as he is required for screen readers to read it correctly !

0 commit comments

Comments
 (0)