Skip to content

Add docs for character limit feature #321

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/draft-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ vars.NETLIFY_SITE_ID }}
with:
args: deploy --dir=build
args: deploy --dir=build --no-build

- name: Find comment
uses: peter-evans/find-comment@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ jobs:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ vars.NETLIFY_SITE_ID }}
with:
args: deploy --dir=build --alias="$GITHUB_REF_NAME"
args: deploy --dir=build --alias="$GITHUB_REF_NAME" --no-build
10 changes: 10 additions & 0 deletions docs/30-components/input-email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,16 @@ Um eine fehlgeschlagene Validierung anzuzeigen, verwenden Sie die Attribute `_ms
| ----- | --------------------------- |
| `Tab` | Fokussiert das Eingabefeld. |

### Character Limit (Prop `_character-limit`)

Über die Prop `_character-limit` lässt sich ein Zeichenlimit für das Eingabefeld festlegen, wobei auch längere Texte eingegeben oder eingefügt und anschließend gekürzt werden können. Es wird stets die Anzahl der verbleibenden Zeichen bzw. die Anzahl der überschrittenen Zeichen angezeigt.

**Verhalten:**
- **Echtzeit-Feedback:** Die verbleibende bzw. überschrittene Zeichenanzahl wird direkt beim Tippen angezeigt.
- **Screenreader-Optimierung:**
- Um den Schreibvorgang nicht zu unterbrechen, erfolgt die Ausgabe der Zeichenanzahl verzögert, sobald **500 ms** keine Eingabe erfolgt ist.
- Beim Fokussieren des Eingabefelds wird das definierte Zeichenlimit angesagt.

## Links und Referenzen

- <kol-link _href="https://medium.com/@gavyn/til-autofocus-inputs-are-an-accessibility-problem-32ced60c3109" _target="_blank"></kol-link>
Expand Down
10 changes: 10 additions & 0 deletions docs/30-components/input-password.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ Zur Behandlung von Events bzw. Callbacks siehe <kol-link _label="Events" _href="
| ----- | --------------------------- |
| `Tab` | Fokussiert das Eingabefeld. |

### Character Limit (Prop `_character-limit`)

Über die Prop `_character-limit` lässt sich ein Zeichenlimit für das Eingabefeld festlegen, wobei auch längere Texte eingegeben oder eingefügt und anschließend gekürzt werden können. Es wird stets die Anzahl der verbleibenden Zeichen bzw. die Anzahl der überschrittenen Zeichen angezeigt.

**Verhalten:**
- **Echtzeit-Feedback:** Die verbleibende bzw. überschrittene Zeichenanzahl wird direkt beim Tippen angezeigt.
- **Screenreader-Optimierung:**
- Um den Schreibvorgang nicht zu unterbrechen, erfolgt die Ausgabe der Zeichenanzahl verzögert, sobald **500 ms** keine Eingabe erfolgt ist.
- Beim Fokussieren des Eingabefelds wird das definierte Zeichenlimit angesagt.

## Links und Referenzen

- <kol-link _href="https://medium.com/@gavyn/til-autofocus-inputs-are-an-accessibility-problem-32ced60c3109" _target="_blank"></kol-link>
Expand Down
10 changes: 10 additions & 0 deletions docs/30-components/input-text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ Zur Behandlung von Events bzw. Callbacks siehe <kol-link _label="Events" _href="
| `Tab` | Fokussiert das Eingabefeld. |
| `ESC` | Löscht den Inhalt (nur Typ = Search). |

### Character Limit (Prop `_character-limit`)

Über die Prop `_character-limit` lässt sich ein Zeichenlimit für das Eingabefeld festlegen, wobei auch längere Texte eingegeben oder eingefügt und anschließend gekürzt werden können. Es wird stets die Anzahl der verbleibenden Zeichen bzw. die Anzahl der überschrittenen Zeichen angezeigt.

**Verhalten:**
- **Echtzeit-Feedback:** Die verbleibende bzw. überschrittene Zeichenanzahl wird direkt beim Tippen angezeigt.
- **Screenreader-Optimierung:**
- Um den Schreibvorgang nicht zu unterbrechen, erfolgt die Ausgabe der Zeichenanzahl verzögert, sobald **500 ms** keine Eingabe erfolgt ist.
- Beim Fokussieren des Eingabefelds wird das definierte Zeichenlimit angesagt.

## Links und Referenzen

- <kol-link _href="https://medium.com/@gavyn/til-autofocus-inputs-are-an-accessibility-problem-32ced60c3109" _target="_blank"></kol-link>
Expand Down
11 changes: 11 additions & 0 deletions docs/30-components/textarea.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,17 @@ Mit Hilfe des Attributs **`_rows`** kann die Höhe der Textarea in Zeilen bestim
| `Tab` | Fokussiert die Textarea. |
| `Pfeil-Tasten` | Können für die Navigation im Inhalt der fokussierten Textarea verwendet werden. |


### Character Limit (Prop `_character-limit`)

Über die Prop `_character-limit` lässt sich ein Zeichenlimit für das Eingabefeld festlegen, wobei auch längere Texte eingegeben oder eingefügt und anschließend gekürzt werden können. Es wird stets die Anzahl der verbleibenden Zeichen bzw. die Anzahl der überschrittenen Zeichen angezeigt.

**Verhalten:**
- **Echtzeit-Feedback:** Die verbleibende bzw. überschrittene Zeichenanzahl wird direkt beim Tippen angezeigt.
- **Screenreader-Optimierung:**
- Um den Schreibvorgang nicht zu unterbrechen, erfolgt die Ausgabe der Zeichenanzahl verzögert, sobald **500 ms** keine Eingabe erfolgt ist.
- Beim Fokussieren des Eingabefelds wird das definierte Zeichenlimit angesagt.

## Links und Referenzen

- <kol-link _href="https://medium.com/@gavyn/til-autofocus-inputs-are-an-accessibility-problem-32ced60c3109" _target="_blank"></kol-link>
Expand Down
Loading