UNPKG

@public-ui/components

Version:

Contains all web components that belong to KoliBri - The accessible HTML-Standard.

public-ui.github.io

public-ui/kolibri

80 lines (50 loc) • 7.86 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# LinkButton Der LinkButton ist semantisch ein Link und hat das Design eines Buttons. Hierzu werden alle relevanten Properties der Link-Komponente übernommen und um die Design-bestimmenden Properties des Buttons erweitert. Weitere Informationen zum Aussehen finden Sie auf der <kol-link _href="/docs/components/button" _label="Seite des Buttons"></kol-link>. ## Konstruktion ### Code ```html <kol-link-button _href="#" _label="Primary" _variant="primary"></kol-link-button> <kol-link-button _href="#" _label="Secondary" _variant="secondary"></kol-link-button> <kol-link-button _href="#" _label="Normal" _variant="normal"></kol-link-button> <kol-link-button _href="#" _label="Secondary" _variant="danger"></kol-link-button> <kol-link-button _href="#" _label="Ghost" _variant="ghost"></kol-link-button> ``` ### Beispiel <div class="flex gap-2"> <kol-link-button _href="#" _label="Primary" _variant="primary"></kol-link-button> <kol-link-button _href="#" _label="Secondary" _variant="secondary"></kol-link-button> <kol-link-button _href="#" _label="Normal" _variant="normal"></kol-link-button> <kol-link-button _href="#" _label="Danger" _variant="danger"></kol-link-button> <kol-link-button _href="#" _label="Ghost" _variant="ghost"></kol-link-button> </div> <!-- Auto Generated Below --> ## Properties | Property | Attribute | Description | Type | Default | | -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | ----------- | | `_accessKey` | `_access-key` | Defines which key combination can be used to trigger or focus the interactive element of the component. | `string` \| `undefined` | `undefined` | | `_ariaCurrentValue` | `_aria-current-value` | Defines the value for the aria-current attribute. | `"date"` \| `"false"` \| `"location"` \| `"page"` \| `"step"` \| `"time"` \| `"true"` \| `undefined` | `undefined` | | `_ariaDescription` | `_aria-description` | Defines the value for the aria-description attribute. | `string` \| `undefined` | `undefined` | | `_customClass` | `_custom-class` | Defines the custom class attribute if _variant="custom" is set. | `string` \| `undefined` | `undefined` | | `_disabled` | `_disabled` | Makes the element not focusable and ignore all events. | `boolean` \| `undefined` | `false` | | `_download` | `_download` | Tells the browser that the link contains a file. Optionally sets the filename. | `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` | | `_href` _(required)_ | `_href` | Defines the target URI of the link. | `string` | `undefined` | | `_icons` | `_icons` | Defines the icon classnames (e.g. `_icons="fa-solid fa-user"`). | `KoliBriHorizontalIcons & KoliBriVerticalIcons` \| `string` \| `undefined` | `undefined` | | `_label` | `_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` | `undefined` | | `_on` | -- | Defines the callback functions for links. | `undefined` \| `{ onClick?: EventValueOrEventCallback<Event, string>` \| `undefined; }` | `undefined` | | `_role` | `_role` | Defines the role of the components primary element. | `"button"` \| `"link"` \| `"tab"` \| `"treeitem"` \| `undefined` | `undefined` | | `_shortKey` | `_short-key` | Adds a visual short key hint to the component. | `string` \| `undefined` | `undefined` | | `_tabIndex` | `_tab-index` | Defines which tab-index the primary element of the component has. (https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) | `number` \| `undefined` | `undefined` | | `_target` | `_target` | Defines where to open the link. | `string` \| `undefined` | `undefined` | | `_tooltipAlign` | `_tooltip-align` | Defines where to show the Tooltip preferably: top, right, bottom or left. | `"bottom"` \| `"left"` \| `"right"` \| `"top"` \| `undefined` | `'right'` | | `_variant` | `_variant` | Defines which variant should be used for presentation. | `"custom"` \| `"danger"` \| `"ghost"` \| `"normal"` \| `"primary"` \| `"secondary"` \| `"tertiary"` \| `undefined` | `'normal'` | ## Methods ### `focus() => Promise<void>` <span class="text-red-500">**[DEPRECATED]**</span> Use kolFocus instead.<br/><br/> #### Returns Type: `Promise<void>` ### `kolFocus() => Promise<void>` #### Returns Type: `Promise<void>` ----------------------------------------------