ados-rcm 1.0.7 → 1.0.9

package/dist/AModule/AComponents/AStepper/AStepper.d.ts

@@ -1,14 +1,73 @@
 /// <reference types="react" />
 import { TUseValues } from '../../AHooks/useValues';
-interface IRendererProps<T> {
+interface IStepRendererProps<T> {
+    /**
+     * step : T
+     * Description : step of AStepper
+     */
     step: T;
+    /**
+     * stepIdx : number
+     * Description : stepIdx of AStepper
+     */
     stepIdx: number;
 }
 export interface IAStepperProps<T> {
-    useStep?: TUseValues<T>;
+    /**
+     * useSelect? : TUseValues<T>
+     * Description : useStep of AStepper
+     * Basic Usage :
+     * (1) const steps = ['Step1', 'Step2', 'Step3'];
+     * const [step, setStep] = useState<typeof steps[0]>(steps[0]);
+     * <AStepper useSelect={[step, setStep]} steps={steps}/>
+     */
+    useSelect?: TUseValues<T>;
+    /**
+     * steps : T[]
+     * Description : steps of AStepper. must have at least one step.
+     * Basic Usage :
+     * (1) const steps = ['Step1', 'Step2', 'Step3'];
+     * <AStepper steps={steps}/>
+     */
     steps: T[];
-    StepRenderer?: (props: IRendererProps<T>) => React.ReactNode;
-    ContentRenderer?: (props: IRendererProps<T>) => React.ReactNode;
+    /**
+     * StepRenderer? : (props: IStepRendererProps<T>) => React.ReactNode = DefaultRenderer
+     * Description : StepRenderer of AStepper
+     * Basic Usage :
+     * (1) const steps = ['Step1', 'Step2', 'Step3'];
+     * const StepRenderer = ({step, stepIdx}) => 'This is step' + stepIdx;
+     * <AStepper steps={steps} StepRenderer={StepRenderer}/>
+     */
+    StepRenderer?: (props: IStepRendererProps<T>) => React.ReactNode;
+    /**
+     * ContentRenderer? : (props: IStepRendererProps<T>) => React.ReactNode = DefaultRenderer
+     * Description : ContentRenderer of AStepper
+     * Basic Usage :
+     * (1) const steps = ['Step1', 'Step2', 'Step3'];
+     * const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
+     * <AStepper steps={steps} ContentRenderer={ContentRenderer}/>
+     */
+    ContentRenderer?: (props: IStepRendererProps<T>) => React.ReactNode;
 }
-export declare const AStepper: <T>({ useStep, steps, StepRenderer, ContentRenderer, }: IAStepperProps<T>) => import("react/jsx-runtime").JSX.Element | null;
+/**
+ * AComponent : AStepper
+ * Description : AStepper is a stepper component that can select a step. all steps are rendered even if they are not selected.
+ * Basic Usage :
+ * (1) const steps = ['Step1', 'Step2', 'Step3'];
+ * return <AStepper steps={steps}/>
+ *
+ * (2) const steps = ['Step1', 'Step2', 'Step3'];
+ * const StepRenderer = ({step, stepIdx}) => 'This is step' + stepIdx;
+ * return <AStepper steps={steps} StepRenderer={StepRenderer}/>
+ *
+ * (3) const steps = ['Step1', 'Step2', 'Step3'];
+ * const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
+ * return <AStepper steps={steps} ContentRenderer={ContentRenderer}/>
+ *
+ * (4) const steps = ['Step1', 'Step2', 'Step3'];
+ * const StepRenderer = ({step, stepIdx}) => 'This is step' + stepIdx;
+ * const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
+ * return <AStepper steps={steps} StepRenderer={StepRenderer} ContentRenderer={ContentRenderer}/>
+ */
+export declare const AStepper: <T>({ useSelect, steps, StepRenderer, ContentRenderer, }: IAStepperProps<T>) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/AModule/AComponents/ASwitch/ASwitch.d.ts

@@ -2,6 +2,23 @@ import { TUseValues } from '../../AHooks/useValues';
 import { IABaseProps } from '../ABase/ABase';
 import { IAWrapProps } from '../AWrap/AWrap';
 export interface ASwitchProps extends IAWrapProps, IABaseProps {
+    /**
+     * useCheck? : TUseValues<any>
+     * Description : ContentRenderer of AStepper
+     * Basic Usage :
+     * (1) const steps = ['Step1', 'Step2', 'Step3'];
+     * const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
+     * <AStepper steps={steps} ContentRenderer={ContentRenderer}/>
+     */
     useCheck?: TUseValues<any>;
 }
+/**
+ * AComponent : ASwitch
+ * Description : ASwitch is a switch component that can be toggled.
+ * Basic Usage :
+ * (1) <ASwitch/>
+ *
+ * (2) const [check, setCheck] = useState<boolean>(false);
+ * <ASwitch useCheck={[check, setCheck]}/>
+ */
 export declare const ASwitch: ({ wrapProps, helperText, label, useCheck, ...abaseProps }: ASwitchProps) => import("react/jsx-runtime").JSX.Element;

package/dist/AModule/AComponents/ATab/ATab.d.ts

@@ -1,14 +1,76 @@
 /// <reference types="react" />
 import { TUseValues } from '../../AHooks/useValues';
 export interface IATabOptionRendererProps<T> {
+    /**
+     * option : T
+     * Description : option of ATab
+     */
     option: T;
 }
 export interface IATabProps<T> {
+    /**
+     * options : T[]
+     * Description : options of ATab
+     * Basic Usage :
+     * (1) const options = ['Option1', 'Option2', 'Option3'];
+     * <ATab options={options}/>
+     */
     options: T[];
+    /**
+     * type? : 'Primary' | 'Secondary' = 'Primary'
+     * Description : type of ATab
+     * Basic Usage :
+     * (1) <ATab type="Secondary"/>
+     */
     type?: 'Primary' | 'Secondary';
+    /**
+     * useSelect? : TUseValues<T>
+     * Description : useSelect of ATab
+     * Basic Usage :
+     * (1) const [selected, setSelected] = useState<typeof options[0]>(options[0]);
+     * <ATab options={options} useSelect={[selected, setSelected]}/>
+     */
     useSelect?: TUseValues<T>;
+    /**
+     * tabProps? : React.HTMLProps<HTMLDivElement>
+     * Description : tabProps of ATab
+     * Basic Usage :
+     * (1) <ATab tabProps={{className: 'test'}}/>
+     */
     tabProps?: React.HTMLProps<HTMLDivElement>;
+    /**
+     * optionWidth? : string | number
+     * Description : optionWidth of ATab. if not set, tabs will have 1/n width.
+     * Basic Usage :
+     * (1) <ATab optionWidth="100px"/>
+     */
     optionWidth?: string | number;
+    /**
+     * OptionRenderer? : (props: IATabOptionRendererProps<T>) => React.ReactNode = DefaultItemRenderer
+     * Description : OptionRenderer of ATab
+     * Basic Usage :
+     * (1) const options = ['Option1', 'Option2', 'Option3'];
+     * const OptionRenderer = ({option}) => 'This is option' + option;
+     * <ATab options={options} OptionRenderer={OptionRenderer}/>
+     */
     OptionRenderer?: (props: IATabOptionRendererProps<T>) => React.ReactNode;
 }
+/**
+ * AComponent : ATab
+ * Description : ATab is a tab component that can select a tab.
+ * Basic Usage :
+ * (1) const options = ['Option1', 'Option2', 'Option3'];
+ * return <ATab options={options}/>
+ *
+ * (2) const options = ['Option1', 'Option2', 'Option3'];
+ * const OptionRenderer = ({option}) => 'This is option' + option;
+ * return <ATab options={options} OptionRenderer={OptionRenderer}/>
+ *
+ * (3) const options = ['Option1', 'Option2', 'Option3'];
+ * const [selected, setSelected] = useState<typeof options[0]>(options[0]);
+ * return <ATab options={options} useSelect={[selected, setSelected]}/>
+ *
+ * (4) const options = ['Option1', 'Option2', 'Option3'];
+ * return <ATab options={options} type="Secondary"/>
+ */
 export declare const ATab: <T>({ options, useSelect, type, tabProps, optionWidth, OptionRenderer, }: IATabProps<T>) => import("react/jsx-runtime").JSX.Element | null;