Skip to content

Commit 3af1b2b

Browse files
include readme into components
1 parent b7c11c0 commit 3af1b2b

File tree

2 files changed

+64
-2
lines changed

2 files changed

+64
-2
lines changed

docs/30-components/kolibri.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,36 @@ tags:
1010

1111
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1212

13+
# Logo
14+
15+
Diese Komponente implementiert das Logo von KoliBri.
16+
17+
## Konstruktion
18+
19+
### Code
20+
21+
```html
22+
<kol-kolibri></kol-kolibri> <kol-kolibri _labeled="false"></kol-kolibri>
23+
```
24+
25+
## Beispiele
26+
27+
<kol-kolibri></kol-kolibri>
28+
<kol-kolibri _labeled="false"></kol-kolibri>
29+
30+
## Barrierefreiheit
31+
32+
<!-- Auto Generated Below -->
33+
34+
## Properties
35+
36+
| Property | Attribute | Description | Type | Default |
37+
| ---------- | ---------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ----------- |
38+
| `_color` | `_color` | Defines the color of the logo and label. | `string \| undefined \| { backgroundColor: string; foregroundColor: Stringified<CharacteristicColors>; }` | `'#003c78'` |
39+
| `_labeled` | `_labeled` | Defines whether the component has a label. | `boolean \| undefined` | `true` |
40+
41+
---
42+
1343
## Live-Editor
1444

1545
<LiveEditorCompact component="kolibri" />

docs/30-components/version.mdx

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,44 @@ tags:
88
- Beispiele
99
---
1010

11-
import Readme from '../../readmes/version/readme.md';
1211
import { Configurator } from '@site/src/components/Configurator';
1312
import { LiveEditorCompact } from '@site/src/components/LiveEditorCompact';
1413
import { ExampleLink } from '@site/src/components/ExampleLink';
1514

16-
<Readme />
15+
# Version
16+
17+
Die **Version**-Komponente stellt kurze Inhalte auf einem farbigen Hintergrund dar. Die **Version**-Komponente ist mit der **Tag**-Komponente eng verwandt, bietet aber nur ein Attribut zur Konfiguration. Sie ist optimiert für die Angabe z.B. von Versionen einer Seite.
18+
19+
## Konstruktion
20+
21+
### Code
22+
23+
```html
24+
<div>
25+
<kol-version _label="1.44.0"></kol-version>
26+
</div>
27+
```
28+
29+
### Beispiel
30+
31+
<kol-version _label="1.44.0"></kol-version>
32+
33+
## Verwendung
34+
35+
Für die Konfiguration steht das Attribut **`_label`** zur Verfügung und nimmt einen beliebigen Text auf, dem in der Komponente ein `v` vorgestellt wird.
36+
37+
Die **Version** wird standardmäßig als **_Inline-Element_** ausgegeben.
38+
39+
<!-- Auto Generated Below -->
40+
41+
## Properties
42+
43+
| Property | Attribute | Description | Type | Default |
44+
| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
45+
| `_label` _(required)_ | `_label` | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | `string` | `undefined` |
46+
47+
---
48+
1749

1850
<ExampleLink component="version" />
1951

0 commit comments

Comments
 (0)