Skip to content

Commit b4026a1

Browse files
committed
docs: update readme's
1 parent fe4adbb commit b4026a1

File tree

42 files changed

+1170
-356
lines changed

Some content is hidden

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

42 files changed

+1170
-356
lines changed

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@
4141
"@leanup/form": "1.3.54",
4242
"@mdx-js/react": "3.0.1",
4343
"@monaco-editor/react": "4.6.0",
44-
"@public-ui/components": "2.1.5",
45-
"@public-ui/react": "2.1.5",
46-
"@public-ui/themes": "2.1.5",
44+
"@public-ui/components": "2.1.7",
45+
"@public-ui/react": "2.1.7",
46+
"@public-ui/themes": "2.1.7",
4747
"classnames": "2.5.1",
4848
"docusaurus-lunr-search": "3.4.0",
4949
"mermaid": "10.9.1",

pnpm-lock.yaml

Lines changed: 19 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

versioned_readmes/1.7/span/readme.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,14 @@ Die **Span**-Komponente dient dazu innerhalb zahlreicher KoliBri-Komponenten die
1616

1717
<!-- Auto Generated Below -->
1818

19-
2019
## Properties
2120

2221
| Property | Attribute | Description | Type | Default |
2322
| --------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ----------- |
2423
| `_hideLabel` | `_hide-label` | Hides the caption by default and displays the caption text with a tooltip when the interactive element is focused or the mouse is over it. | `boolean` \| `undefined` | `false` |
25-
| `_icon` | `_icon` | <span className="text-red-500">**[DEPRECATED]**</span> Use _icons.<br/><br/> | `KoliBriHorizontalIcons & KoliBriVerticalIcons` \| `string` \| `undefined` | `undefined` |
26-
| `_iconOnly` | `_icon-only` | <span className="text-red-500">**[DEPRECATED]**</span> use _hide-label<br/><br/>Deprecated: Hides the label and shows the description in a Tooltip instead. | `boolean` \| `undefined` | `undefined` |
24+
| `_icon` | `_icon` | <span className="text-red-500">**[DEPRECATED]**</span> Use _icons.<br/><br/> | `KoliBriHorizontalIcons & KoliBriVerticalIcons` \| `string` \| `undefined` | `undefined` |
25+
| `_iconOnly` | `_icon-only` | <span className="text-red-500">**[DEPRECATED]**</span> use _hide-label<br/><br/>Deprecated: Hides the label and shows the description in a Tooltip instead. | `boolean` \| `undefined` | `undefined` |
2726
| `_icons` | `_icons` | Defines the icon classnames (e.g. `_icons="fa-solid fa-user"`). | `KoliBriHorizontalIcons & KoliBriVerticalIcons` \| `string` \| `undefined` | `undefined` |
2827
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). Set to `false` to enable the expert slot. | `string` | `undefined` |
2928

30-
31-
----------------------------------------------
32-
33-
29+
---

versioned_readmes/2.1/accordion/readme.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
Synonyme: Collapse
2+
13
Die **Accordion**-Komponente ist ein Aufklapp-Menü. Klickt man auf den Kopfbereich, bestehend aus Icon und Überschrift, klappt der Inhalt mit zusätzlichen Informationen auf. Somit ist es ein interaktives Navigationselement, welches dazu dient, umfangreiche Inhalte platzsparend darzustellen.
24

35
Accordions kommen immer dann zum Einsatz, wenn einem thematischen Oberbegriff zugeordnete Inhalte angezeigt oder verborgen werden sollen. Sie erlauben umfangreichere Detailinformationen zu einem Oberbegriff, als es aus Gründen der Übersichtlichkeit eigentlich sinnvoll wäre. Sie überlassen es den Besucher:innen selbst, ob sie sich diese Informationen anzeigen lassen möchten.
@@ -117,6 +119,31 @@ Standardansicht gelegt.
117119
| `_open` | `_open` | If set (to true) opens/expands the element, closes if not set (or set to false). | `boolean` \| `undefined` | `false` |
118120

119121

122+
## Methods
123+
124+
### focus
125+
126+
`focus() => Promise<void>`
127+
128+
<span className="text-red-500">**[DEPRECATED]**</span> Use kolFocus instead.<br/><br/>
129+
130+
#### Returns
131+
132+
Type: `Promise<void>`
133+
134+
135+
136+
### `kolFocus() => Promise<void>`
137+
138+
139+
140+
#### Returns
141+
142+
Type: `Promise<void>`
143+
144+
145+
146+
120147
## Slots
121148

122149
| Slot | Description |

versioned_readmes/2.1/alert/readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
Synonyme: Message
2+
13
Die **Alert**-Komponente gibt ein optisches Feedback an die Nutzer:innen. Sie besteht aus einem farblich gestalteten Container, einer Überschrift, einem Inhaltstext sowie einem Icon. Das verwendete Icon und die farbliche Gestaltung sind abhängig vom Typ `_type` des Alert.
24

35
## Konstruktion

versioned_readmes/2.1/avatar/readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
Synonyme: Persona
2+
13
Die **Avatar**-Komponente zeigt entweder ein kleines Bild des Users oder dessen Initialen an, falls kein Bild vorhanden ist.
24

35
## Konstruktion

0 commit comments

Comments
 (0)