arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-20 23:11:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(components): add @IconifyIcon tag on icon properties (#3445)

Browse Source
This commit is contained in:
Romain Hamel
2025-03-04 10:40:13 +01:00
committed by GitHub
parent ccbd89c908
commit fb4e05c65f
24 changed files with 106 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/runtime/composables/useComponentIcons.ts
View File

@@ -3,23 +3,33 @@ import { useAppConfig } from '#imports'
import type { AvatarProps } from '../types'
export interface UseComponentIconsProps {
/** Display an icon based on the `leading` and `trailing` props. */
/**
* Display an icon based on the `leading` and `trailing` props.
* @IconifyIcon
*/
icon?: string
/** Display an avatar on the left side. */
avatar?: AvatarProps
/** When `true`, the icon will be displayed on the left side. */
leading?: boolean
/** Display an icon on the left side. */
/**
* Display an icon on the left side.
* @IconifyIcon
*/
leadingIcon?: string
/** When `true`, the icon will be displayed on the right side. */
trailing?: boolean
/** Display an icon on the right side. */
/**
* Display an icon on the right side.
* @IconifyIcon
*/
trailingIcon?: string
/** When `true`, the loading icon will be displayed. */
loading?: boolean
/**
* The icon when the `loading` prop is `true`.
* @defaultValue appConfig.ui.icons.loading
* @IconifyIcon
*/
loadingIcon?: string
}