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

docs: add comments in shared.ts

Browse Source
This commit is contained in:
p-sw 2024-05-21 19:37:40 +09:00
parent 35959233f6
commit 934aa2244b
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/react/shared.ts
View File

@ -72,6 +72,7 @@ type VariantKV<V extends VariantType> = {
* opened: false,
* size: "md",
* color: "green",
* className: "transition-opacity",
* },
* }
* ```
@ -80,7 +81,14 @@ type PresetType<V extends VariantType, N extends string> = {
[PresetName in N]: Partial<VariantKV<V>> & { className?: string };
};
export function vcn<V extends VariantType, N extends string>({
/**
* A utility function to provide variants and presets to the component
*
* @param config - Variant Configuration
* @returns function (variantProps) -> class name,
* @returns function (anyProps) -> [variantProps, otherProps]
*/
export function vcn<V extends VariantType, N extends string /* Preset names */>({
base,
variants,
defaults,
@ -133,7 +141,7 @@ export function vcn<V extends VariantType, N extends string>({
: defaultValue)
]
),
currentPreset?.className,
currentPreset?.className, // preset's classname comes after user's variant props? huh..
className
);
},