Skip to content

Commit 902a4b1

Browse files
author
jannik.lange
committed
✨ added documentation #182
1 parent b974ac7 commit 902a4b1

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/components/Link/MucLink.vue

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,29 @@ import { MucIcon } from "../Icon";
2323
2424
const props = withDefaults(
2525
defineProps<{
26+
/**
27+
* Text shown as the link
28+
*/
2629
label: string;
30+
31+
/**
32+
* href to link to
33+
*/
2734
href?: string;
35+
36+
/**
37+
* Optional icon displayed behind the text
38+
*/
2839
icon?: string;
40+
41+
/**
42+
* Target on the link
43+
*/
2944
target?: string;
45+
46+
/**
47+
* Removes the underline from the label text
48+
*/
3049
noUnderline?: boolean;
3150
}>(),
3251
{
@@ -36,6 +55,17 @@ const props = withDefaults(
3655
}
3756
);
3857
58+
defineSlots<{
59+
/**
60+
* Icon slots overrides chosen prop icon.
61+
* The icon can be displayed infront or behind the label with these classes: icon--after | icon--before
62+
*/
63+
icon(): void;
64+
}>();
65+
66+
/**
67+
* Computed class to remove the underline if chosen.
68+
*/
3969
const reversedUnderlineClass = computed(() =>
4070
props.noUnderline ? "m-link--reversed-underline" : ""
4171
);

0 commit comments

Comments
 (0)