Skip to content

Commit 7a746d4

Browse files
committed
docs(readme): Add documentation on the new screenReader configuration option
1 parent 3bba270 commit 7a746d4

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,17 @@ NOTA BENE: If the only reason you are storing strings is to have it properly for
229229
please review the documentation on ngModelController $formatters and $parsers. These allow you to store a value in the model
230230
but display it formatted as you like in the view. In other words, stop it! =)
231231

232+
### screenReader
233+
The next and previous arrows on the directive had hidden (when useing bootstrap.css) text for screen readers.
234+
It also provide some default translations for various languages. However, if you need another translation, you can specify
235+
the translations in the configuration.
236+
237+
The screenReader option must be an object with ```previous``` and ```next``` properties.
238+
239+
```html
240+
<datetimepicker data-ng-model="data.date" data-datetimepicker-config="{ screenReader: { 'previous': 'go previous', 'next': 'go next' }}"></datetimepicker>
241+
```
242+
232243

233244
### dropdownSelector
234245

0 commit comments

Comments
 (0)