Skip to content

Commit 7bec0db

Browse files
committed
docs(useLabelIcon): document arguments
1 parent 331215d commit 7bec0db

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

apps/docs/guide/composables/useLabelIcon.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ const { labelIcon, labelIconPosition } = useLabelIcon(props.field.labelIcon)
1313
</script>
1414
```
1515

16+
## Arguments
17+
### `iconDefinition` <Badge type="info" text="string | ComponentPublicInstance | LabelIconDefinition" />
18+
::: details LabelIconDefinition type
19+
```ts
20+
type LabelIconDefinition = {
21+
icon: string | ComponentPublicInstance;
22+
position: 'left' | 'right';
23+
}
24+
```
25+
:::
26+
Either a string webfont class, a component or `LabelIconDefinition`.
27+
1628
## Returns
1729
1830
### `labelIcon` <Badge type="info" text="ComputedRef<string | ComponentPublicInstance | null>" />

0 commit comments

Comments
 (0)