Skip to content

Function: useBaseProps()

ts
function useBaseProps(props: BaseSetupProps): {
  all: ComputedRef<BaseProps>;
  filtered: ComputedRef<ResolvedBaseProps>;
};

Composable that extracts and filters BaseField props into typed computed references. Provides both all defined props and a filtered set with undefined values removed.

Parameters

ParameterTypeDescription
propsBaseSetupPropsThe BaseField setup props

Returns

ts
{
  all: ComputedRef<BaseProps>;
  filtered: ComputedRef<ResolvedBaseProps>;
}

An object with 'all' (all defined props) and 'filtered' (without undefined) computed refs

NameType
allComputedRef<BaseProps>
filteredComputedRef<ResolvedBaseProps>

Example

typescript
const { all, filtered } = useBaseProps(props);
// all: includes all explicitly defined props
// filtered: only includes props that have defined values