Skip to content

@vtj


@vtj / ui / useIconProps

Function: useIconProps()

useIconProps(iconRef): ComputedRef<null | Partial<ExtractPropTypes<{ background: { type: StringConstructor; }; color: { type: StringConstructor; }; hoverEffect: { type: BooleanConstructor; }; icon: { type: PropType<string | object | VNode<RendererNode, RendererElement, {[key: string]: any; }>>; }; padding: { type: NumberConstructor; }; radius: { type: NumberConstructor; }; size: { default: string; type: PropType<IconSize>; }; src: { type: StringConstructor; }; }>>>

Defined in: packages/ui/types/hooks/useIcon.d.ts:3

Parameters

iconRef

MaybeRef<undefined | IconParam>

Returns

ComputedRef<null | Partial<ExtractPropTypes<{ background: { type: StringConstructor; }; color: { type: StringConstructor; }; hoverEffect: { type: BooleanConstructor; }; icon: { type: PropType<string | object | VNode<RendererNode, RendererElement, {[key: string]: any; }>>; }; padding: { type: NumberConstructor; }; radius: { type: NumberConstructor; }; size: { default: string; type: PropType<IconSize>; }; src: { type: StringConstructor; }; }>>>

Released under the MIT License.