ados-rcm 1.0.9 → 1.0.12

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

@@ -5,16 +5,19 @@ import { IAWrapProps } from '../AWrap/AWrap';
 export interface IASelectSelectedRendererProps<TItem, TGivenSelected, TSelected = TGivenSelected extends Array<TItem> ? TItem[] : null | TItem> {
     /**
      * OptionRenderer : (props: IASelectOptionRendererProps<T>) => React.ReactNode
+     *
      * Description : OptionRenderer of ASelect
      */
     OptionRenderer: (props: IASelectOptionRendererProps<TItem>) => React.ReactNode;
     /**
      * selected : T[]
+     *
      * Description : selected items of ASelect
      */
     selected: TSelected;
     /**
      * placeholder : React.ReactNode
+     *
      * Description : placeholder of ASelect
      */
     placeholder?: React.ReactNode;
@@ -22,6 +25,7 @@ export interface IASelectSelectedRendererProps<TItem, TGivenSelected, TSelected
 export interface IASelectOptionRendererProps<TItem> {
     /**
      * option : T
+     *
      * Description : option of ASelect
      */
     option: TItem;
@@ -29,106 +33,102 @@ export interface IASelectOptionRendererProps<TItem> {
 export interface IASelectProps<TItem, TGivenSelected, TSelected = TGivenSelected extends Array<TItem> ? TItem[] : null | TItem> extends IABaseProps, IAWrapProps {
     /**
      * options : T[]
+     *
      * Description : options of ASelect
-     * Basic Usage :
-     * (1) const options = ['Option1', 'Option2', 'Option3'];
-     * <ASelect options={options}/>
      */
     options: TItem[];
     /**
      * useSelect? : TUseValues<T[]>
+     *
      * Description : useSelect of ASelect
-     * Basic Usage :
-     * (1) const [selected, setSelected] = useState<T[]>([]);
-     * <ASelect options={options} useSelect={[selected, setSelected]}/>
      */
     useSelect?: TUseValues<TSelected>;
     /**
      * type? : 'Primary' | 'Secondary' = 'Primary'
+     *
      * Description : type of ASelect
-     * Basic Usage :
-     * (1) <ASelect type="Secondary"/>
      */
     type?: 'Primary' | 'Secondary';
     /**
      * placeholder? : React.ReactNode
+     *
      * Description : placeholder of ASelect. it is shown when no option is selected
-     * Basic Usage :
-     * (1) <ASelect placeholder="Select"/>
      */
     placeholder?: React.ReactNode;
     /**
      * isSelectMulti? : boolean = false
+     *
      * Description : isSelectMulti of ASelect. if it is true, multiple options can be selected
-     * Basic Usage :
-     * (1) <ASelect isSelectMulti/>
      */
     isSelectMulti?: boolean;
     /**
      * onClose? : () => void
+     *
      * Description : onClose of ASelect
-     * Basic Usage :
-     * (1) <ASelect onClose={() => console.log('closed')}/>
      */
     onClose?: () => void;
     /**
      * SelectedRenderer? : (props: IASelectSelectedRendererProps<T>) => React.ReactNode = DefaultSelectedRenderer
+     *
      * Description : Renderer of Selected Options of ASelect
-     * Basic Usage :
-     * (1) <ASelect SelectedRenderer={({selected, placeholder}) => selected ? selected : placeholder}/>
      */
     SelectedRenderer?: (props: IASelectSelectedRendererProps<TItem, TGivenSelected, TSelected>) => React.ReactNode;
     /**
      * OptionRenderer? : (props: IASelectOptionRendererProps<T>) => React.ReactNode = DefaultOptionRenderer
+     *
      * Description : Renderer of Options of ASelect
-     * Basic Usage :
-     * (1) <ASelect OptionRenderer={({option}) => <div>{option}</div>}/>
      */
     OptionRenderer?: (props: IASelectOptionRendererProps<TItem>) => React.ReactNode;
     /**
      * minShowRows? : number = 2
+     *
      * Description : minShowRows of ASelect
-     * Basic Usage :
-     * (1) <ASelect minShowRows={2}/>
      */
     minShowRows?: number;
     /**
      * maxShowRows? : number = 6
+     *
      * Description : maxShowRows of ASelect. scrollbar will appear when overflow
-     * Basic Usage :
-     * (1) <ASelect maxShowRows={6}/>
      */
     maxShowRows?: number;
     /**
      * arrowProps? : React.HTMLProps<HTMLDivElement>
+     *
      * Description : divProps for Arrow of ASelect
-     * Basic Usage :
-     * (1) <ASelect arrowProps={{style: {color: 'red'}}}/>
      */
     arrowProps?: React.HTMLProps<HTMLDivElement>;
 }
 /**
  * AComponent : ASelect
+ *
  * Description : ASelect is a select component. give options and useSelect to select an option.
+ *
  * Basic Usage :
- * (1) const options = ['Option1', 'Option2', 'Option3'];
- * const [selected, setSelected] = useState<string | null>(null);
- * return <ASelect options={options} useSelect={[selected, setSelected]}/>
  *
- * (2) const options = ['Option1', 'Option2', 'Option3'];
- * const [selected, setSelected] = useState<string[]>([]);
- * return <ASelect options={options} useSelect={[selected, setSelected]} isSelectMulti/>
+ *     const strOptions = ['Option1', 'Option2', 'Option3'];
+ *     const options = [{idx : 1, name : 'option1'}, {idx : 2, name : 'option2'}, {idx : 3, name : 'option3'}];
+ *     const [strSelected, setStrSelected] = useState<string | null>(null);
+ *     const [selected, setSelected] = useState<{idx : number, name : string}[]>([]);
+ *     const OptionRenderer = ({option}) => <div>{option.name}</div>;
+ *     const SelectedRenderer = ({selected, placeholder}) => selected.length > 0 ? string.join(selected.map(e => e.name), ', ') : placeholder;
+ *
+ *     if (case 1)
+ *       <ASelect options={strOptions}
+ *         useSelect={[strSelected, setStrSelected]}/>
+ *
+ *     if (case 2)
+ *       <ASelect options={options}
+ *         useSelect={[selected, setSelected]}
+ *         OptionRenderer={OptionRenderer}
+ *         isSelectMulti
  *
- * (3) const options = [{idx : 1, name : 'option1'}, {idx : 2, name : 'option2'}, {idx : 3, name : 'option3'}];
- * const [selected, setSelected] = useState<{idx : number, name : string}[]>([]);
- * const OptionRenderer = ({option}) => <div>{option.name}</div>;
- * return <ASelect options={options} useSelect={[selected, setSelected]} OptionRenderer={OptionRenderer}/>
+ *     if (case 3)
+ *       <ASelect options={options}
+ *         useSelect={[selected, setSelected]}
+ *         OptionRenderer={OptionRenderer}
+ *         SelectedRenderer={SelectedRenderer}
+ *         isSelectMulti/>
  *
- * (4) const options = [{idx : 1, name : 'option1'}, {idx : 2, name : 'option2'}, {idx : 3, name : 'option3'}];
- * const [selected, setSelected] = useState<{idx : number, name : string}[]>([]);
- * const OptionRenderer = ({option}) => <div>{option.name}</div>;
- * const SelectedRenderer = ({selected, placeholder}) => selected.length > 0 ? string.join(selected.map(e => e.name), ', ') : placeholder;
- * return <ASelect options={options} useSelect={[selected, setSelected]} OptionRenderer={OptionRenderer} SelectedRenderer={SelectedRenderer}/>
  */
 export declare const ASelect: <TItem, TGivenSelected, TSelected = TGivenSelected extends TItem[] ? TItem[] : TItem | null>({ options, useSelect, type, placeholder, isSelectMulti, onClose, SelectedRenderer, OptionRenderer, minShowRows, maxShowRows, arrowProps, wrapProps, helperText, label, ...abaseProps }: IASelectProps<TItem, TGivenSelected, TSelected>) => React.ReactNode;
 export declare const DefaultOptionRenderer: <T>({ option }: IASelectOptionRendererProps<T>) => React.ReactNode;

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

@@ -2,28 +2,26 @@ import { HTMLAttributes } from 'react';
 interface IASpaceProps extends HTMLAttributes<HTMLElement> {
     /**
      * h? : number | string
+     *
      * Description : height of ASpace
-     * Basic Usage :
-     * (1) <ASpace h={10}/>
      */
     h?: number | string;
     /**
      * w? : number | string
+     *
      * Description : width of ASpace
-     * Basic Usage :
-     * (1) <ASpace w={10}/>
      */
     w?: number | string;
 }
 /**
  * AComponent : ASpace
+ *
  * Description : ASpace is a component to make spaces.
- * Basic Usage :
- * (1) <ASpace h={10}/>
  *
- * (2) <ASpace w={10}/>
+ * Basic Usage :
  *
- * (3) <ASpace h={10} w={10}/>
+ *     if (case 1)
+ *       <ASpace h={10} w={10}/>
  */
 export declare const ASpace: ({ h, w, ...divProps }: IASpaceProps) => React.ReactNode;
 export {};

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

@@ -3,11 +3,13 @@ import { TUseValues } from '../../AHooks/useValues';
 interface IStepRendererProps<T> {
     /**
      * step : T
+     *
      * Description : step of AStepper
      */
     step: T;
     /**
      * stepIdx : number
+     *
      * Description : stepIdx of AStepper
      */
     stepIdx: number;
@@ -15,59 +17,56 @@ interface IStepRendererProps<T> {
 export interface IAStepperProps<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: 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;
 }
 /**
  * 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}/>
+ *     const steps = ['Step1', 'Step2', 'Step3'];
+ *     const StepRenderer = ({step, stepIdx}) => 'This is step' + stepIdx;
+ *     const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
+ *
+ *     if (case 1)
+ *       <AStepper steps={steps}/>
+ *
+ *     if (case 2)
+ *       <AStepper steps={steps}
+ *         StepRenderer={StepRenderer}/>
+ *
+ *     if (case 3)
+ *       <AStepper steps={steps}
+ *         ContentRenderer={ContentRenderer}/>
  *
- * (3) const steps = ['Step1', 'Step2', 'Step3'];
- * const ContentRenderer = ({step, stepIdx}) => 'This is content' + stepIdx;
- * return <AStepper steps={steps} ContentRenderer={ContentRenderer}/>
+ *     if (case 4)
+ *       <AStepper steps={steps}
+ *         StepRenderer={StepRenderer}
+ *         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

@@ -4,21 +4,24 @@ 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}/>
+     *
+     * Description : useCheck of ASwitch
      */
     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]}/>
+ *     const [check, setCheck] = useState<boolean>(false);
+ *
+ *     if (case 1)
+ *       <ASwitch/>
+ *
+ *     if (case 2)
+ *       <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

@@ -3,6 +3,7 @@ import { TUseValues } from '../../AHooks/useValues';
 export interface IATabOptionRendererProps<T> {
     /**
      * option : T
+     *
      * Description : option of ATab
      */
     option: T;
@@ -10,67 +11,65 @@ export interface IATabOptionRendererProps<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}/>
+ *     const options = ['Option1', 'Option2', 'Option3'];
+ *     const [selected, setSelected] = useState<typeof options[0]>(options[0]);
+ *     const OptionRenderer = ({option}) => 'This is option' + option;
+ *
+ *     if (case 1)
+ *       <ATab options={options}/>
+ *
+ *     if (case 2)
+ *       <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]}/>
+ *     if (case 3)
+ *       <ATab options={options}
+ *         useSelect={[selected, setSelected]}/>
  *
- * (4) const options = ['Option1', 'Option2', 'Option3'];
- * return <ATab options={options} type="Secondary"/>
+ *     if (case 4)
+ *       <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;