p-sw/pswui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add comment in shared

Browse Source
This commit is contained in:
p-sw 2024-05-26 17:20:02 +09:00
parent 6ec67941bf
commit aa0b45a320
1 changed files with 41 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
packages/react/shared.tsx
View File

@ -90,16 +90,25 @@ type PresetType<V extends VariantType> = {
* @returns function (anyProps) -> [variantProps, otherProps] * @returns function (anyProps) -> [variantProps, otherProps]
*/ */
export function vcn<V extends VariantType>(param: { export function vcn<V extends VariantType>(param: {
/**
* First definition: without presets
*/
base?: string | undefined; base?: string | undefined;
variants: V; variants: V;
defaults: VariantKV<V>; defaults: VariantKV<V>;
presets?: undefined; presets?: undefined;
}): [ }): [
/**
* Variant Props -> Class Name
*/
( (
variantProps: Partial<VariantKV<V>> & { variantProps: Partial<VariantKV<V>> & {
className?: string; className?: string;
} }
) => string, ) => string,
/**
* Any Props -> Variant Props, Other Props
*/
<AnyPropBeforeResolve extends Record<string, any>>( <AnyPropBeforeResolve extends Record<string, any>>(
anyProps: AnyPropBeforeResolve anyProps: AnyPropBeforeResolve
) => [ ) => [
@ -110,17 +119,26 @@ export function vcn<V extends VariantType>(param: {
], ],
]; ];
export function vcn<V extends VariantType, P extends PresetType<V>>(param: { export function vcn<V extends VariantType, P extends PresetType<V>>(param: {
/**
* Second definition: with presets
*/
base?: string | undefined; base?: string | undefined;
variants: V /* VariantType */; variants: V /* VariantType */;
defaults: VariantKV<V>; defaults: VariantKV<V>;
presets: P; presets: P;
}): [ }): [
/**
* Variant Props -> Class Name
*/
( (
variantProps: Partial<VariantKV<V>> & { variantProps: Partial<VariantKV<V>> & {
className?: string; className?: string;
preset?: keyof P; preset?: keyof P;
} }
) => string, ) => string,
/**
* Any Props -> Variant Props, Other Props
*/
<AnyPropBeforeResolve extends Record<string, any>>( <AnyPropBeforeResolve extends Record<string, any>>(
anyProps: AnyPropBeforeResolve anyProps: AnyPropBeforeResolve
) => [ ) => [
@ -241,6 +259,15 @@ export type VariantProps<F extends (props: any) => string> = F extends (
? P ? P
: never; : never;
/**
* Merges the react props.
* Basically childProps will override parentProps.
* But if it is a event handler, style, or className, it will be merged.
*
* @param parentProps - The parent props.
* @param childProps - The child props.
* @returns The merged props.
*/
function mergeReactProps( function mergeReactProps(
parentProps: Record<string, any>, parentProps: Record<string, any>,
childProps: Record<string, any> childProps: Record<string, any>
@ -271,6 +298,12 @@ function mergeReactProps(
return { ...parentProps, ...overrideProps }; return { ...parentProps, ...overrideProps };
} }
/**
* Takes an array of refs, and returns a single ref.
*
* @param refs - The array of refs.
* @returns The single ref.
*/
function combinedRef<I>(refs: React.Ref<I | null>[]) { function combinedRef<I>(refs: React.Ref<I | null>[]) {
return (instance: I | null) => return (instance: I | null) =>
refs.forEach((ref) => { refs.forEach((ref) => {