Skip to content

Commit 449b14d

Browse files
committed
docs(a11y-buttons): replace old docs with to-do
1 parent ab9ac3e commit 449b14d

File tree

2 files changed

+6
-150
lines changed

2 files changed

+6
-150
lines changed

packages/accessibility-buttons/README.md

Lines changed: 3 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -21,85 +21,13 @@ npm install accessibility-buttons --save
2121

2222
## Usage
2323

24-
Import
25-
26-
- accessibility-buttons/dist/css/accessibility-buttons.css
27-
- accessibility-buttons/dist/js/accessibility-buttons.js
28-
29-
Add buttons
30-
31-
```html
32-
<button type="button" data-accessibility="font">+A</button>
33-
<button type="button" data-accessibility="contrast">Add Contrast</button>
34-
```
35-
36-
Initialize after DOM ready
37-
38-
```js
39-
accessibilityButtons()
40-
```
24+
TO-DO
4125

4226
**Note:** Note: Font size works only with `em` or `rem` units.
4327

44-
## Settings
45-
46-
To set up `buttons names` and `aria-labels`, use the following parameters.
47-
48-
```js
49-
// default values
50-
accessibilityButtons({
51-
font: {
52-
nameButtonIncrease: '+A',
53-
ariaLabelButtonIncrease: 'Increase Font',
54-
nameButtonDecrease: '-A',
55-
ariaLabelButtonDecrease: 'Decrease Font'
56-
},
57-
58-
contrast: {
59-
nameButtonAdd: 'Add Contrast',
60-
ariaLabelButtonAdd: 'Add Contrast',
61-
nameButtonRemove: 'Remove Contrast',
62-
ariaLabelButtonRemove: 'Remove Contrast'
63-
}
64-
})
65-
```
28+
## Styling
6629

67-
`Font size` and `contrast colors` could be customized only overwritting class values.
68-
69-
Example:
70-
71-
```css
72-
body {
73-
font-size: 1em;
74-
color: #a9a9a9;
75-
background: #000;
76-
}
77-
78-
body input,
79-
body textarea,
80-
body select,
81-
body button {
82-
/* The default font-size of these elements is approximately 20% less than the body */
83-
font-size: 0.9em;
84-
}
85-
86-
body.accessibility-font {
87-
font-size: 1.5em;
88-
}
89-
90-
body.accessibility-font input,
91-
body.accessibility-font textarea,
92-
body.accessibility-font select,
93-
body.accessibility-font button {
94-
/* The default font-size of these elements is approximately 20% less than the body */
95-
font-size: 1.2em;
96-
}
97-
98-
body.accessibility-contrast {
99-
color: #000;
100-
background: #a9a9a9;
101-
}
102-
```
30+
TO-DO
10331

10432
## Contributing
10533

packages/accessibility-buttons/README.pt-br.md

Lines changed: 3 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -23,85 +23,13 @@ npm install accessibility-buttons --save
2323

2424
## Uso
2525

26-
Importe
27-
28-
- accessibility-buttons/dist/css/accessibility-buttons.css
29-
- accessibility-buttons/dist/js/accessibility-buttons.js
30-
31-
Insira os botões
32-
33-
```html
34-
<button type="button" data-accessibility="font">+A</button>
35-
<button type="button" data-accessibility="contrast">Add Contrast</button>
36-
```
37-
38-
Inicializando após o DOM ser carregado
39-
40-
```js
41-
accessibilityButtons()
42-
```
26+
TO-DO
4327

4428
**Observação:** Font size só funciona com as unidades `em` ou `rem`.
4529

46-
## Configurações
47-
48-
Para configurar os `nomes dos botões` e `aria-labels`, use os seguinte parâmetros:
49-
50-
```js
51-
// default values
52-
accessibilityButtons({
53-
font: {
54-
nameButtonIncrease: '+A',
55-
ariaLabelButtonIncrease: 'Increase Font',
56-
nameButtonDecrease: '-A',
57-
ariaLabelButtonDecrease: 'Decrease Font'
58-
},
59-
60-
contrast: {
61-
nameButtonAdd: 'Add Contrast',
62-
ariaLabelButtonAdd: 'Add Contrast',
63-
nameButtonRemove: 'Remove Contrast',
64-
ariaLabelButtonRemove: 'Remove Contrast'
65-
}
66-
})
67-
```
30+
## Estilização
6831

69-
`Font size` e `cores do contraste` podem ser customizados sobrescrevendo as classes.
70-
71-
Exemplo
72-
73-
```css
74-
body {
75-
font-size: 1em;
76-
color: #a9a9a9;
77-
background: #000;
78-
}
79-
80-
body input,
81-
body textarea,
82-
body select,
83-
body button {
84-
/* The default font-size of these elements is approximately 20% less than the body */
85-
font-size: 0.9em;
86-
}
87-
88-
body.accessibility-font {
89-
font-size: 1.5em;
90-
}
91-
92-
body.accessibility-font input,
93-
body.accessibility-font textarea,
94-
body.accessibility-font select,
95-
body.accessibility-font button {
96-
/* The default font-size of these elements is approximately 20% less than the body */
97-
font-size: 1.2em;
98-
}
99-
100-
body.accessibility-contrast {
101-
color: #000;
102-
background: #a9a9a9;
103-
}
104-
```
32+
TO-DO
10533

10634
## Contribua
10735

0 commit comments

Comments
 (0)