ados-rcm 1.0.10 → 1.0.13

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

@@ -5,59 +5,66 @@ export interface IABaseProps extends React.HTMLAttributes<HTMLElement> {
     children?: React.ReactNode;
     /**
      * abaseRef? : React.RefObject<HTMLDivElement>
-     * <br/>Description : ref of ABase   *
-     * <br/>Basic Usage :
-     * <br/>(1)const ref = useRef<HtmlDivElement>();
-     * <ABase abaseRef={ref}/>
+     *
+     * Description : ref of ABase
      */
     abaseRef?: React.RefObject<HTMLDivElement>;
     /**
      * isDisabled? : any
-     * <br/>Description : if truthy, dimming is applied. if isLoading is true, spinner is dimmed as well.
-     * <br/>Basic Usage :
-     * <br/>(1)<ABase isDisabled/>
+     *
+     * Description : if truthy, dimming is applied. if isLoading is true, spinner is dimmed as well.
      */
     isDisabled?: any;
     /**
      * isLoading? : any
-     * <br/>Description : if truthy, dimming and spinner are applied.
-     * <br/>Basic Usage :
-     * <br/>(1)<ABase isLoading/>
+     *
+     * Description : if truthy, dimming and spinner are applied.
      */
     isLoading?: any;
     /**
      * tooltip? : React.ReactNode
-     * <br/>Description : tooltip. if tooltip is truthy, tooltip is shown.
-     * <br/>Basic Usage :
-     * <br/>(1)<ABase tooltip="tooltip text"/>
-     * <br/>(2)<ABase tooltip={<div>tooltip text</div>}/>
+     *
+     * Description : tooltip. if tooltip is truthy, tooltip is shown.
      */
     tooltip?: React.ReactNode;
     /**
      * tooltipDistance? : number = 10
-     * <br/>Description : distance in pixels between tooltip and target.
-     * <br/>Basic Usage :
-     * <br/>(1)<ABase tooltipDistance={10}/>
+     *
+     * Description : distance in pixels between tooltip and target.
      */
     tooltipDistance?: number;
     /**
      * tooltipDelay? : number
-     * <br/>Description : delay in seconds of tooltip after mouse enter.
-     * <br/>Basic Usage :
-     * <br/>(1)<ABase tooltipDelay={100}/>
+     *
+     * Description : delay in seconds of tooltip after mouse enter.
      */
     tooltipDelay?: number;
 }
 /**
  * AComponent : ABase
- * <br/>Description : ABase is a base component(like div) that can have isDisabled, isLoading and tooltip.
- * <br/>Basic Usage :
- * <br/>(1)return <ABase>{children}</ABase>
  *
- * <br/>(2)return <ABase isDisabled>{children}</ABase>
+ * Description : ABase is a base component(like div) that can have isDisabled, isLoading and tooltip.
  *
- * <br/>(3)return <ABase isLoading>{children}</ABase>
+ * Basic Usage :
  *
- * <br/>(4)return <ABase tooltip="tooltip text">{children}</ABase>
+ *     if (case 1)
+ *       <ABase>
+ *         {children}
+ *       </ABase>
+ *
+ *     if (case 2)
+ *       <ABase isDisabled>
+ *         {children}
+ *       </ABase>
+ *
+ *     if (case 3)
+ *       <ABase isLoading>
+ *         {children}
+ *       </ABase>
+ *
+ *     if (case 4)
+ *       <ABase tooltip="tooltip text">
+ *         {children}
+ *       </ABase>
  */
 export declare const ABase: (props: IABaseProps) => React.ReactNode;

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

@@ -4,18 +4,32 @@ export type TAButtonType = 'Primary' | 'Secondary' | 'Undefined';
 export interface IAButtonProps extends IABaseProps, IAWrapProps {
     /**
      * type? : TAButtonType = 'Primary'
-     * <br/>Description : type of IAButton
-     * <br/>Basic Usage :
-     * <br/>(1)<AButton type="Secondary"/>
+     *
+     * Description : type of IAButton
      */
     type?: TAButtonType;
 }
 /**
  * AComponent : AButton
- * <br/>Description : AButton is a button component.
- * <br/>Basic Usage :
- * <br/>(1)<AButton onClick={onClick}>Click Me</AButton>
  *
- * <br/>(2)<AButton type="Secondary" onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'Button Disabled'}>Click Me</AButton>
+ * Description : AButton is a button component.
+ *
+ * Basic Usage :
+ *
+ *     const onClick = () => { console.log('Button Clicked') }
+ *     const [isDisabled, setIsDisabled] = useState(false)
+ *
+ *     if (case 1)
+ *       <AButton onClick={onClick}>
+ *         Click Me
+ *       </AButton>
+ *
+ *     if (case 2)
+ *       <AButton type="Secondary"
+ *         onClick={onClick}
+ *         isDisabled={isDisabled}
+ *         tooltip={isDisabled && 'Button Disabled'}>
+ *         Click Me
+ *       </AButton>
  */
 export declare const AButton: (props: IAButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/AModule/AComponents/AButton/AIconButton.d.ts

@@ -3,24 +3,30 @@ import { TIcons } from '../AIcon/AIcon';
 interface IAIconButtonProps extends IABaseProps {
     /**
      * icon : TIcons
-     * <br/>Description : icon of AIconButton
-     * <br/>Basic Usage :
-     * <br/>(1)<AIconButton icon="Alert"/>
+     *
+     * Description : icon of AIconButton
      */
     icon: TIcons;
     /**
      * size? : 'Small' | 'Medium' | 'Large' = 'Medium'
-     * <br/>Description : size of AIconButton
-     * <br/>Basic Usage :
-     * <br/>(1)<AIconButton icon="Alert" size="Small"/>
+     *
+     * Description : size of AIconButton
      */
     size?: 'Small' | 'Medium' | 'Large';
 }
 /**
  * AComponent : AIconButton
- * <br/>Description : AIconButton is a button component with an Icon.
- * <br/>Basic Usage :
- * <br/>(1)<AIconButton icon="Alert" size="Small" onClick={onClick}/>
+ *
+ * Description : AIconButton is a button component with an Icon.
+ *
+ * Basic Usage :
+ *
+ *     const onClick = () => { console.log('Button Clicked') }
+ *
+ *     if (case 1)
+ *       <AIconButton icon="Alert"
+ *         size="Small"
+ *         onClick={onClick}/>
  */
 export declare const AIconButton: (props: IAIconButtonProps) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -2,26 +2,33 @@ import { TUseValues } from '../../AHooks/useValues';
 import { IABaseProps } from '../ABase/ABase';
 export interface IACheckBoxProps extends IABaseProps {
     /**
-     * useCheck? : TUseValues<any>
-     * <br/>Description : [useCheck, setUseCheck] = useValues of ACheckBox. if useCheck is truthy, ACheckBox is checked.
-     * <br/>Basic Usage :
-     * <br/>(1)const [useCheck, setUseCheck] = useState(false);
-     * <ACheckBox useCheck={[useCheck, setUseCheck]}/>
+     * useCheck? : TUseValues&lt;any>
+     *
+     * Description : [useCheck, setUseCheck] = useValues of ACheckBox. if useCheck is truthy, ACheckBox is checked.
      */
     useCheck?: TUseValues<any>;
     /**
      * isIndeterminate? : boolean
-     * <br/>Description : if true, ACheckBox is indeterminate. priority is higher than useCheck.
-     * <br/>Basic Usage :
-     * <br/>(1)<ACheckBox isIndeterminate/>
+     *
+     * Description : if true, ACheckBox is indeterminate. priority is higher than useCheck.
      */
     isIndeterminate?: boolean;
 }
 /**
  * AComponent : ACheckBox
- * <br/>Description : ACheckBox is a checkbox component.
- * <br/>Basic Usage :
- * <br/>(1)const [useCheck, setUseCheck] = useState(false);
- * <ACheckBox useCheck={[useCheck, setUseCheck]} onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'CheckBox Disabled'} />
+ *
+ * Description : ACheckBox is a checkbox component.
+ *
+ * Basic Usage :
+ *
+ *     const onClick = () => { console.log('Button Clicked') }
+ *
+ *     if (case 1)
+ *       <AIconButton icon="Alert"
+ *         size="Small"
+ *         onClick={onClick}/>
+ *
+ *     <ACheckBox useCheck={[useCheck, setUseCheck]} onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'CheckBox Disabled'} />
+ *
  */
 export declare const ACheckBox: ({ useCheck, isIndeterminate, ...abaseProps }: IACheckBoxProps) => React.ReactNode;

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

@@ -5,77 +5,71 @@ import { TActionRef } from '../ATypes/ATypes';
 export interface IAClockActions {
     /**
      * start : () => void
-     * <br/>Description : start clock running
+     *
+     * Description : start clock running
      */
     start: () => void;
     /**
      * stop : () => void
-     * <br/>Description : stop clock running
+     *
+     * Description : stop clock running
      */
     stop: () => void;
     /**
      * reset : () => void
-     * <br/>Description : set clock's tick to maxTicks and stop clock running
+     *
+     * Description : set clock's tick to maxTicks and stop clock running
      */
     reset: () => void;
     /**
      * setTicks : (ticks: number) => void
-     * <br/>Description : set clock's tick to specified number
+     *
+     * Description : set clock's tick to specified number
      */
     setTicks: (ticks: number) => void;
 }
 export interface IAClockProps extends IAWrapProps, IABaseProps {
     /**
      * maxTicks? : number = 300
-     * <br/>Description : maxTicks of AClock
-     * <br/>Basic Usage :
-     * <br/>(1)<AClock maxTicks={180}/>
+     *
+     * Description : maxTicks of AClock
      */
     maxTicks?: number;
     /**
      * interval? : number = 1000
-     * <br/>Description : interval in milliseconds of AClock
-     * <br/>Basic Usage :
-     * <br/>(1)<AClock interval={500}/>
+     *
+     * Description : interval in milliseconds of AClock
      */
     interval?: number;
     /**
      * onFinish? : () => void
-     * <br/>Description : onFinish of AClock
-     * <br/>Basic Usage :
-     * <br/>(1)<AClock onFinish={onFinish}/>
+     *
+     * Description : onFinish of AClock
      */
     onFinish?: () => void;
     /**
-     * actionRef? : TActionRef<IAClockActions>
-     * <br/>Description : actionRef of AClock
-     * <br/>Basic Usage :
-     * <br/>(1)const actionRef = useRef<IAClockActions>();
-     * <AClock actionRef={ref}/>
+     * actionRef? : TActionRef&lt;IAClockActions>
+     *
+     * Description : actionRef of AClock
      */
     actionRef?: TActionRef<IAClockActions>;
 }
 /**
  * AComponent : AClock
- * <br/>Description : AClock is a clock component.
- * <br/>Basic Usage :
- * <br/>(1)const actionRef = useRef<IAClockActions>();
- * const onStartClick = () => {
- *   actionRef.current?.start();
- * }
- * const onStopClick = () => {
- *  actionRef.current?.stop();
- * }
- * const onResetClick = () => {
- *   actionRef.current?.reset();
- * }
- * return (
- *   <div>
- *     <AClock onFinish={onFinish} actionRef={ref}/>
- *     <AButton onClick={onStartClick}>Start</AButton>
- *     <AButton onClick={onStopClick}>Stop</AButton>
- *     <AButton onClick={onResetClick}>Reset</AButton>
- *   </div>
- * )
+ *
+ * Description : AClock is a clock component.
+ *
+ * Basic Usage :
+ *
+ *     const actionRef = useRef<IAClockActions>()
+ *     const onFinish = () => { console.log('Clock Finished') }
+ *     const onStartClick = () => { actionRef.current?.start() }
+ *     const onStopClick = () => { actionRef.current?.stop() }
+ *
+ *     if (case 1)
+ *       <AClock onFinish={onFinish} actionRef={ref}/>
+ *       <AButton onClick={onStartClick}>Start</AButton>
+ *       <AButton onClick={onStopClick}>Stop</AButton>
+ *       <AButton onClick={actionRef.current?.reset}>Reset</AButton>
  */
 export declare const AClock: ({ maxTicks, interval, onFinish, actionRef, wrapProps, helperText, label, ...abaseProps }: IAClockProps) => React.ReactNode;

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

@@ -1,113 +1,98 @@
 /// <reference types="react" />
 import { TUseValues } from '../../AHooks/useValues';
-import { EDir12, TActionRef } from '../ATypes/ATypes';
 import { Resources } from '../AResource/AResource';
+import { EDir12, TActionRef } from '../ATypes/ATypes';
 export interface IADatePickerActions {
     /**
      * open : () => void
-     * <br/>Description : opens calendar when called
+     *
+     * Description : opens calendar when called
      */
     open: () => void;
     /**
      * close : () => void
-     * <br/>Description : closes calendar when called
+     *
+     * Description : closes calendar when called
      */
     close: () => void;
     /**
      * toggle : () => void
-     * <br/>Description : toggles calendar(open <> close) when called
+     *
+     * Description : toggles calendar(open <> close) when called
      */
     toggle: () => void;
 }
 export interface IADatePickerProps {
     /**
      * className? : string
-     * <br/>Description : className of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker className="className"/>
+     *
+     * Description : className of ADatePicker
      */
     className?: string;
     /**
      * useDate? : TUseValues<Date>
-     * <br/>Description : useDate of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)const [date, setDate] = useState(new Date());
-     * <ADatePicker useDate={[date, setDate]}/>
-     * <br/>(2)const [date, setDate] = useState(new Date());
-     * const onDateChange = (newDate: Date) => {
-     *  setDate(newDate);
-     * }
-     * <ADatePicker useDate={[date, onDateChange]}/>
+     *
+     * Description : useDate of ADatePicker
      */
     useDate?: TUseValues<Date>;
     /**
      * position? : EDir12 = EDir12.SE
-     * <br/>Description : position of calendar
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker position={EDir12.E}/>
+     *
+     * Description : position of calendar
      */
     position?: EDir12;
     /**
      * actionRef? : TActionRef<IADatePickerActions>
-     * <br/>Description : actionRef of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)const actionRef = useRef<IADatePickerActions>();
-     * return (
-     * <>
-     *   <ADatePicker actionRef={ref}/>
-     *   <AButton onClick={() => ref.current?.open()}>Open</AButton>
-     *   <AButton onClick={() => ref.current?.close()}>Close</AButton>
-     * </>
+     *
+     * Description : actionRef of ADatePicker
      */
     actionRef?: TActionRef<IADatePickerActions>;
     /**
      * minDate? : Date = new Date(new Date().getFullYear() - 1, new Date().getMonth(), new Date().getDate())
-     * <br/>Description : minimum date of ADatePicker. default is a year ago from now
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker minDate={new Date(2021, 0, 1)}/>
+     *
+     * Description : minimum date of ADatePicker. default is a year ago from now
      */
     minDate?: Date;
     /**
      * maxDate? : Date = new Date(new Date().getFullYear() + 1, new Date().getMonth(), new Date().getDate())
-     * <br/>Description : maximum date of ADatePicker. default is a year later from now
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker maxDate={new Date(2022, 0, 1)}/>
+     *
+     * Description : maximum date of ADatePicker. default is a year later from now
      */
     maxDate?: Date;
     /**
      * resources? : Partial<typeof Resources.ADatePicker>
-     * <br/>Description : language resources of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker resources={{months: (x) => 'current month :' +  x}}/>
+     *
+     * Description : language resources of ADatePicker
      */
     resources?: Partial<typeof Resources.ADatePicker>;
     /**
      * LeftAddon? : React.ReactNode
-     * <br/>Description : LeftAddon of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker LeftAddon={<AIcon icon="Alert"/>}/>
+     *
+     * Description : LeftAddon of ADatePicker
      */
     LeftAddon?: React.ReactNode;
     /**
      * RightAddon? : React.ReactNode
-     * <br/>Description : RightAddon of ADatePicker
-     * <br/>Basic Usage :
-     * <br/>(1)<ADatePicker RightAddon={<AIcon icon="Alert"/>}/>
+     *
+     * Description : RightAddon of ADatePicker
      */
     RightAddon?: React.ReactNode;
 }
 /**
  * AComponent : ADatePicker
- * <br/>Description : ADatePicker is a component for selecting single date.
- * <br/>Basic Usage :
- * <br/>(1)const actionRef = useRef<IADatePickerActions>();
- * const [date, setDate] = useState(new Date());
- * return (
- *   <>
- *     <ADatePicker useDate={[date, setDate]} actionRef={actionRef}/>
- *     <AButton onClick={() => actionRef.current?.open()}>Open</AButton>
- *     <AButton onClick={() => actionRef.current?.close()}>Close</AButton>
- *   </>
- * )
+ *
+ * Description : ADatePicker is a component for selecting single date.
+ *
+ * Basic Usage :
+ *
+ *     const actionRef = useRef<IADatePickerActions>();
+ *     const [date, setDate] = useState(new Date());
+ *
+ *     if (case 1)
+ *       <ADatePicker useDate={[date, setDate]} actionRef={actionRef}/>
+ *       <AButton onClick={actionRef.current?.open}>Open</AButton>
+ *       <AButton onClick={actionRef.current?.close}>Close</AButton>
+ *       <AButton onClick={actionRef.current?.toggle}>Toggle</AButton>
+ *
  */
 export declare const ADatePicker: ({ className, useDate, actionRef, position, minDate: exMinDate, maxDate: exMaxDate, resources: extResources, LeftAddon, RightAddon, }: IADatePickerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/AModule/AComponents/ADatePicker/ADateRangePicker.d.ts

@@ -3,42 +3,40 @@ import { IADatePickerProps } from './ADatePicker';
 export interface IDateRange {
     /**
      * sDate : Date;
-     * <br/>Description : start date of IDateRange
+     *
+     * Description : start date of IDateRange
      */
     sDate: Date;
     /**
      * eDate : Date;
-     * <br/>Description : end date of IDateRange
+     *
+     * Description : end date of IDateRange
      */
     eDate: Date;
 }
 export interface IADateRangePickerProps extends Omit<IADatePickerProps, 'useDate'> {
     /**
      * useDateRange : TUseValues<IDateRange>;
-     * <br/>Description : useDateRange of ADateRangePicker
-     * <br/>Basic Usage :
-     * <br/>(1)const [useDateRange, setUseDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
-     * return <ADateRangePicker useDateRange={[useDateRange, setUseDateRange]} />
-     * <br/>(2)const useDateRange = useValues<IDateRange>({ sDate: new Date(), eDate: new Date() });
-     * const onDateRangeChange = (newDateRange: IDateRange) => {
-     *  setUseDateRange(newDateRange);
-     * };
-     * return <ADateRangePicker useDateRange={[useDateRange, onDateRangeChange]} />
+     *
+     * Description : useDateRange of ADateRangePicker
      */
     useDateRange?: TUseValues<IDateRange>;
 }
 /**
  * AComponent : ADateRangePicker
- * <br/>Description : ADateRangePicker is a component for selecting dateRange
- * <br/>Basic Usage :
- * <br/>(1)const actionRef = useRef<IADatePickerActions>();
- * const [dateRange, setDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
- * return (
- *   <>
- *     <ADateRangePicker useDateRange={[dateRange, setDateRange]} actionRef={actionRef} />
- *     <AButton onClick={() => actionRef.current?.open()}>Open</AButton>
- *     <AButton onClick={() => actionRef.current?.close()}>Close</AButton>
- *   </>
- * )
+ *
+ * Description : ADateRangePicker is a component for selecting dateRange
+ *
+ * Basic Usage :
+ *
+ *     const actionRef = useRef<IADatePickerActions>();
+ *     const [dateRange, setDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
+ *
+ *     if (case 1)
+ *       <ADateRangePicker useDateRange={[dateRange, setDateRange]} actionRef={actionRef} />
+ *       <AButton onClick={actionRef.current?.open}>Open</AButton>
+ *       <AButton onClick={actionRef.current?.close}>Close</AButton>
+ *       <AButton onClick={actionRef.current?.toggle}>Toggle</AButton>
+ *
  */
 export declare const ADateRangePicker: ({ className, useDateRange, actionRef, position, minDate: exMinDate, maxDate: exMaxDate, resources: extResources, LeftAddon, RightAddon, }: IADateRangePickerProps) => import("react/jsx-runtime").JSX.Element;