Skip to content

Commit 3ff4b0d

Browse files
AlexanderSchmidtCEAlexanderSchmidtCE
committed
added readme for auto generated
1 parent 4d7cb5f commit 3ff4b0d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+109
-1624
lines changed

‎docs/30-components/abbr.mdx

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Beispiele
99
---
1010

11+
import Readme from '../../readmes/abbr/readme.md';
1112
import { Configurator } from '@site/src/components/Configurator';
1213
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1314
import { ExampleLink } from '@site/src/components/ExampleLink';
@@ -54,22 +55,7 @@ Der KoliBri Tooltip kann von Screenreadern vorgelesen werden und verändert sein
5455

5556
- <kol-link _href="https://developer.mozilla.org/de/docs/Web/HTML/Element/abbr" _target="_blank"></kol-link>
5657

57-
<!-- Auto Generated Below -->
58-
59-
## Properties
60-
61-
| Property | Attribute | Description | Type | Default |
62-
| --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | ----------- |
63-
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
64-
| `_tooltipAlign` | `_tooltip-align` | Defines where to show the Tooltip preferably: top, right, bottom or left. | `"bottom" \| "left" \| "right" \| "top" \| undefined` | `'top'` |
65-
66-
## Slots
67-
68-
| Slot | Description |
69-
| ---- | --------------------------------------- |
70-
| | Der Begriff, der erläutert werden soll. |
71-
72-
---
58+
<Readme />
7359

7460

7561
<ExampleLink component="abbr" />

‎docs/30-components/accordion.mdx

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -122,42 +122,7 @@ Standardansicht gelegt.
122122

123123
- <kol-link _href="https://www.w3.org/TR/wai-aria-practices/#accordion" _target="_blank"></kol-link>
124124

125-
<!-- Auto Generated Below -->
126-
127-
## Properties
128-
129-
| Property | Attribute | Description | Type | Default |
130-
| --------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | ----------- |
131-
| `_disabled` | `_disabled` | Makes the element not focusable and ignore all events. | `boolean \| undefined` | `false` |
132-
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
133-
| `_level` | `_level` | Defines which H-level from 1-6 the heading has. 0 specifies no heading and is shown as bold text. | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| undefined` | `1` |
134-
| `_on` | -- | Gibt die EventCallback-Funktionen an. | `undefined \| { onClick?: EventValueOrEventCallback<MouseEvent, boolean> \| undefined; }` | `undefined` |
135-
| `_open` | `_open` | If set (to true) opens/expands the element, closes if not set (or set to false). | `boolean \| undefined` | `false` |
136-
137-
## Methods
138-
139-
### `focus() => Promise<void>`
140-
141-
<span style={{color:"red"}}>**[DEPRECATED]**</span> Use kolFocus instead.<br/><br/>
142-
143-
#### Returns
144-
145-
Type: `Promise<void>`
146-
147-
### `kolFocus() => Promise<void>`
148-
149-
#### Returns
150-
151-
Type: `Promise<void>`
152-
153-
## Slots
154-
155-
| Slot | Description |
156-
| ---- | ------------------------------------------------------------------------------- |
157-
| | Ermöglicht das Einfügen beliebigen HTML's in den Inhaltsbereich des Accordions. |
158-
159-
---
160-
125+
<Readme />
161126

162127
<ExampleLink component="accordion" />
163128

‎docs/30-components/alert.mdx

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77
- Spezifikation
88
- Beispiele
99
---
10-
10+
import Readme from '../../readmes/alert/readme.md';
1111
import { Configurator } from '@site/src/components/Configurator';
1212
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1313
import { ExampleLink } from '@site/src/components/ExampleLink';
@@ -98,28 +98,7 @@ Bei der **Alert**-Komponente wurden insbesondere folgende Punkte der Barrierefre
9898

9999
- <kol-link _href="https://www.w3.org/TR/wai-aria-practices/#alert" _target="_blank"></kol-link>
100100

101-
<!-- Auto Generated Below -->
102-
103-
## Properties
104-
105-
| Property | Attribute | Description | Type | Default |
106-
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | ----------- |
107-
| `_alert` | `_alert` | Defines whether the screen-readers should read out the notification. | `boolean \| undefined` | `false` |
108-
| `_hasCloser` | `_has-closer` | Defines whether the element can be closed. | `boolean \| undefined` | `false` |
109-
| `_label` | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string \| undefined` | `undefined` |
110-
| `_level` | `_level` | Defines which H-level from 1-6 the heading has. 0 specifies no heading and is shown as bold text. | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| undefined` | `1` |
111-
| `_on` | -- | Gibt die EventCallback-Function für das Schließen des Alerts an. | `undefined \| { onClose?: EventCallback<Event> \| undefined; }` | `undefined` |
112-
| `_type` | `_type` | Defines either the type of the component or of the components interactive element. | `"default" \| "error" \| "info" \| "success" \| "warning" \| undefined` | `'default'` |
113-
| `_variant` | `_variant` | Defines which variant should be used for presentation. | `"card" \| "msg" \| undefined` | `'msg'` |
114-
115-
## Slots
116-
117-
| Slot | Description |
118-
| ---- | ----------------------- |
119-
| | Der Inhalt der Meldung. |
120-
121-
---
122-
101+
<Readme />
123102

124103
<ExampleLink component="alert" />
125104

‎docs/30-components/avatar.mdx

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Beispiele
99
---
1010

11+
import Readme from '../../readmes/avatar/readme.md';
1112
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1213
import { ExampleLink } from '@site/src/components/ExampleLink';
1314

@@ -57,17 +58,7 @@ Bei der **Avatar**-Komponente wurden insbesondere folgende Punkte der Barrierefr
5758
- Die Initialen, die alternativ zum Avatar-Bild gezeigt werden, werden als rein visuelles, semantisch nicht relevantes Element betrachtet und für Screenreader
5859
entsprechend versteckt.
5960

60-
<!-- Auto Generated Below -->
61-
62-
## Properties
63-
64-
| Property | Attribute | Description | Type | Default |
65-
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------ | --------------------- | ----------- |
66-
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
67-
| `_src` | `_src` | Sets the image `src` attribute to the given string. | `string \| undefined` | `undefined` |
68-
69-
---
70-
61+
<Readme />
7162

7263
<ExampleLink component="avatar" />
7364

‎docs/30-components/badge.mdx

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Beispiele
99
---
1010

11+
import Readme from '../../readmes/badge/readme.md';
1112
import { Configurator } from '@site/src/components/Configurator';
1213
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1314
import { ExampleLink } from '@site/src/components/ExampleLink';
@@ -109,19 +110,7 @@ Die zusätzliche Ausgabe eines **Icon** gewährleistet, dass der Nutzer auch hie
109110

110111
<kol-alert _type="info">Eine explizite Angabe der Textfarbe ist nicht möglich.</kol-alert>
111112

112-
<!-- Auto Generated Below -->
113-
114-
## Properties
115-
116-
| Property | Attribute | Description | Type | Default |
117-
| --------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
118-
| `_color` | `_color` | Defines the backgroundColor and foregroundColor. | `string \| undefined \| { backgroundColor: string; foregroundColor: Stringified<CharacteristicColors>; }` | `'#000'` |
119-
| `_icons` | `_icons` | Defines the icon classnames (e.g. `_icons="fa-solid fa-user"`). | `KoliBriHorizontalIcons & KoliBriVerticalIcons \| string \| undefined` | `undefined` |
120-
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
121-
| `_smartButton` | `_smart-button` | Allows to add a button with an arbitrary action within the element (\_hide-label only). | `string \| undefined \| { _label: string; } & { _tabIndex?: number \| undefined; _value?: Stringified<StencilUnknown>; _ariaExpanded?: boolean \| undefined; _role?: "button" \| "link" \| "tab" \| "treeitem" \| undefined; _ariaControls?: string \| undefined; _ariaDescription?: string \| undefined; _ariaSelected?: boolean \| undefined; _on?: ButtonCallbacksPropType<StencilUnknown> \| undefined; _type?: "button" \| "reset" \| "submit" \| undefined; _variant?: "primary" \| "secondary" \| "normal" \| "tertiary" \| "danger" \| "ghost" \| "custom" \| undefined; _customClass?: string \| undefined; _disabled?: boolean \| undefined; _hideLabel?: boolean \| undefined; _icons?: IconsPropType \| undefined; _id?: string \| undefined; _name?: string \| undefined; _syncValueBySelector?: string \| undefined; _tooltipAlign?: AlignPropType \| undefined; _accessKey?: string \| undefined; }` | `undefined` |
122-
123-
---
124-
113+
<Readme />
125114

126115
<ExampleLink component="badge" />
127116

‎docs/30-components/breadcrumb.mdx

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Beispiele
99
---
1010

11+
import Readme from '../../readmes/breadcrumb/readme.md';
1112
import { Configurator } from '@site/src/components/Configurator';
1213
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1314
import { ExampleLink } from '@site/src/components/ExampleLink';
@@ -97,16 +98,7 @@ Beachten Sie, dass auch das letzte Element in der Breadcrumb-Komponente per Tab-
9798

9899
- <kol-link _href="https://www.w3.org/TR/wai-aria-practices/#breadcrumb" _target="_blank"></kol-link>
99100

100-
<!-- Auto Generated Below -->
101-
102-
## Properties
103-
104-
| Property | Attribute | Description | Type | Default |
105-
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------- | ----------- |
106-
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
107-
| `_links` _(required)_ | `_links` | Defines the list of links combined with their labels to render. | `BreadcrumbLinkProps[] \| string` | `undefined` |
108-
109-
---
101+
<Readme />
110102

111103
<ExampleLink component="breadcrumb" />
112104

‎docs/30-components/button-group.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags:
88
- Beispiele
99
---
1010

11+
import Readme from '../../readmes/button-group/readme.md';
1112
import { Configurator } from '@site/src/components/Configurator';
1213
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1314
import { ExampleLink } from '@site/src/components/ExampleLink';
@@ -102,9 +103,7 @@ Bei Verwendung der **ButtonGroup**-Komponente sind keine besonderen Maßnahmen i
102103

103104
- <kol-link _href="https://www.w3.org/TR/wai-aria-practices/#button" _target="_blank"></kol-link>
104105

105-
<!-- Auto Generated Below -->
106-
107-
---
106+
<Readme />
108107

109108
<ExampleLink component="button-group" />
110109

0 commit comments

Comments
 (0)