@public-ui/components
Version:
Contains all web components that belong to KoliBri - The accessible HTML-Standard.
33 lines (21 loc) • 2.49 kB
Markdown
# Span
<kol-alert _type="warning" _variant="card">
Die **Span**-Komponente wird innerhalb von KoliBri verwendet und ist nicht dafür vorgesehen in der Anwendungsentwicklung direkt verwendet zu werden. Denn der Span ist nur dann wirklich barrierefrei, wenn er in Kombination mit dem Tooltip verwendet wird.
</kol-alert>
Die **Span**-Komponente dient dazu innerhalb zahlreicher KoliBri-Komponenten die Text-Icon-Kombination und das Expert-Slot-Konzept einheitlich umzusetzen.
## Konstruktion
### Code
```html
<kol-span _icons="codicon codicon-home" _label="Text inside the span."></kol-span>
```
### Beispiel
<kol-span _icons="codicon codicon-home" _label="Text inside the span."></kol-span>
<!-- Auto Generated Below -->
## Properties
| Property | Attribute | Description | Type | Default |
| --------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ----------- |
| `_accessKey` | `_access-key` | Defines the elements access key. | `string` \| `undefined` | `undefined` |
| `_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` |
| `_icons` | `_icons` | Defines the g classnames (e.g. `_icons="fa-solid fa-user"`). | `KoliBriHorizontalIcons & KoliBriVerticalIcons` \| `string` \| `undefined` | `undefined` |
| `_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` |
---