ados-rcm 1.0.10 → 1.0.12

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

@@ -9,27 +9,32 @@ import { IAEventCallers, TActionRef } from '../ATypes/ATypes';
 export interface IADialogActions {
     /**
      * open : () => void
-     * <br/>Description : open dialog
+     *
+     * Description : open dialog
      */
     open: () => void;
     /**
      * close : () => void
-     * <br/>Description : close dialog
+     *
+     * Description : close dialog
      */
     close: () => void;
     /**
      * toggle : () => void
-     * <br/>Description : toggle dialog
+     *
+     * Description : toggle dialog
      */
     toggle: () => void;
     /**
      * ok : () => void
-     * <br/>Description : run ok of the dialog
+     *
+     * Description : run ok of the dialog
      */
     ok: () => void;
     /**
      * cancel : () => void
-     * <br/>Description : run cancel of the dialog
+     *
+     * Description : run cancel of the dialog
      */
     cancel: () => void;
 }
@@ -37,115 +42,98 @@ export type TADialogTypes = 'okCancel' | 'cancelOk' | 'ok' | 'cancel' | 'none';
 export interface IADialogProps {
     /**
      * type? : TADialogTypes = 'okCancel'
-     * <br/>Description : type of dialog. decides the type of action buttons
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog type='cancelOk'/>
+     *
+     * Description : type of dialog. decides the type of action buttons
      */
     type?: TADialogTypes;
     /**
      * title? : React.ReactNode
-     * <br/>Description : title of the dialog
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog title='Title'/>
+     *
+     * Description : title of the dialog
      */
     title?: React.ReactNode;
     /**
      * actionRef? : TActionRef<IADialogActions>
-     * <br/>Description : actionRef of the dialog
-     * <br/>Basic Usage :
-     * <br/>(1)const actionRef = useRef<IADialogActions>();
-     * return <ADialog actionRef={ref}/>
+     *
+     * Description : actionRef of the dialog
      */
     actionRef?: TActionRef<IADialogActions>;
     /**
      * children? : React.ReactNode
-     * <br/>Description : children of the dialog
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog>children</ADialog>
+     *
+     * Description : children of the dialog
      */
     children?: React.ReactNode;
     /**
      * onOk : (e: IAEventCallers) => void;
-     * <br/>Description : onOk of the dialog. it closes the dialog by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onOk={onOk}/>
-     * <br/>(2)<ADialog onOk={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onOk of the dialog. it closes the dialog by default
      */
     onOk?: (e: IAEventCallers) => void;
     /**
      * onCancel : (e: IAEventCallers) => void;
-     * <br/>Description : onCancel of the dialog. it closes the dialog by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onCancel={onCancel}/>
-     * <br/>(2)<ADialog onCancel={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onCancel of the dialog. it closes the dialog by default
      */
     onCancel?: (e: IAEventCallers) => void;
     /**
      * onEnterPress : (e: IAEventCallers) => void;
-     * <br/>Description : onEnterPress of the dialog. it runs ok by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onEnterPress={onEnterPress}/>
-     * <br/>(2)<ADialog onEnterPress={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onEnterPress of the dialog. it runs ok by default
      */
     onEnterPress?: (e: IAEventCallers) => void;
     /**
      * onEscPress : (e: IAEventCallers) => void;
-     * <br/>Description : onEscPress of the dialog. it runs cancel by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onEscPress={onEscPress}/>
-     * <br/>(2)<ADialog onEscPress={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onEscPress of the dialog. it runs cancel by default
      */
     onEscPress?: (e: IAEventCallers) => void;
     /**
      * onSpacePress : (e: IAEventCallers) => void;
-     * <br/>Description : onSpacePress of the dialog. it runs ok by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onSpacePress={onSpacePress}/>
-     * <br/>(2)<ADialog onSpacePress={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onSpacePress of the dialog. it runs ok by default
      */
     onSpacePress?: (e: IAEventCallers) => void;
     /**
      * onPaperClick : (e: IAEventCallers) => void;
-     * <br/>Description : onPaperClick of the dialog. it runs cancel by default
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog onPaperClick={onPaperClick}/>
-     * <br/>(2)<ADialog onPaperClick={(e) =>  e.preventDefault()}/>
+     *
+     * Description : onPaperClick of the dialog. it runs cancel by default
      */
     onPaperClick?: (e: IAEventCallers) => void;
     /**
      * noDim? : boolean = false
-     * <br/>Description : decides whether the dialog has dim or not
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog noDim/>
+     *
+     * Description : decides whether the dialog has dim or not
      */
     noDim?: boolean;
     /**
      * resources? : Partial<typeof Resources.ADialog>
-     * <br/>Description : language resources of the dialog
-     * <br/>Basic Usage :
-     * <br/>(1)<ADialog resources={{ ok: "I'm ok", cancel: "I'm Cancel" }}/>
+     *
+     * Description : language resources of the dialog
      */
     resources?: Partial<typeof Resources.ADialog>;
 }
 /**
  * AComponent : ADialog
- * <br/>Description : ADialog is a dialog component.
- * <br/>Basic Usage :
- * <br/>(1)const actionRef = useRef<IADialogActions>();
- * const onOk = () => {
- *  console.log('ok');
- * }
- * const onCancel = () => {
- *   console.log('cancel');
- * }
- * return (
- *   <div>
- *     <ADialog actionRef={actionRef} title='Dialog Title onOk={onOk} onCancel={onCancel}>
- *       <div>Content</div>
- *     </ADialog>
- *     <AButton onClick={actionRef.current?.open}>Open</AButton>
- *     <AButton onClick={actionRef.current?.close}>Close</AButton>
- *   </div>
- * )
+ *
+ * Description : ADialog is a dialog component.
+ *
+ *
+ * Basic Usage :
+ *
+ *     const actionRef = useRef<IADialogActions>();
+ *     const onOk = () => { console.log('ok') }
+ *     const onCancel = () => { console.log('cancel') }
+ *
+ *     if (case 1)
+ *       <ADialog actionRef={actionRef}
+ *         title='Dialog Title'
+ *         onOk={onOk}
+ *         onCancel={onCancel}>
+ *         <div>Content</div>
+ *       </ADialog>
+ *       <AButton onClick={actionRef.current?.open}>Open</AButton>
+ *       <AButton onClick={actionRef.current?.close}>Close</AButton>
+ *
  */
 export declare const ADialog: ({ type, title, actionRef, children, onOk: extOnOk, onCancel: extOnCancel, onEnterPress: extOnEnterPress, onEscPress: extOnEscPress, onSpacePress: extOnSpacePress, onPaperClick: extOnPaperClick, noDim, resources: extResources, }: IADialogProps) => import("react").ReactPortal | null;

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

@@ -5,39 +5,41 @@ import { Resources } from '../AResource/AResource';
 export interface IFileRendererProps {
     /**
      * file : File
-     * <br/>Description : file to render
+     *
+     * Description : file to render
      */
     file: File;
 }
 export interface IAFileBoxProps extends IABaseProps {
     /**
      * useFile : TUseValues<File | null>
-     * <br/>Description : useFile of AFileBox
-     * <br/>Basic Usage :
-     * <br/>(1)const [file, setFile] = useState<File | null>(null);
-     * <AFileBox useFile={[file, setFile]}/>
+     *
+     * Description : useFile of AFileBox
      */
     useFile: TUseValues<File | null>;
     /**
      * FileRenderer? : (props: IFileRendererProps) => React.ReactNode
-     * <br/>Description : FileRenderer of AFileBox
-     * <br/>Basic Usage :
-     * <br/>(1)<AFileBox FileRenderer={file => <div>{file.name}</div>}/>
+     *
+     * Description : FileRenderer of AFileBox
      */
     FileRenderer?: (props: IFileRendererProps) => React.ReactNode;
     /**
      * resources? : typeof Resources.AFileBox
-     * <br/>Description : resources of AFileBox
-     * <br/>Basic Usage :
-     * <br/>(1)<AFileBox resources={{'or Drag & Drop': 'or Drag the File and Drop it here'}}/>
+     *
+     * Description : resources of AFileBox
      */
     resources?: typeof Resources.AFileBox;
 }
 /**
  * AComponent : AFileBox
- * <br/>Description : AFileBox is a file box component that can select a file.
- * <br/>Basic Usage :
- * <br/>(1)const [file, setFile] = useState<File | null>(null);
- * return <AFileBox useFile={[file, setFile]}/>
+ *
+ * Description : AFileBox is a file box component that can select a file.
+ *
+ * Basic Usage :
+ *
+ *     const [file, setFile] = useState<File | null>(null);
+ *
+ *     if (case 1)
+ *       <AFileBox useFile={[file, setFile]}/>
  */
 export declare const AFileBox: ({ useFile, FileRenderer, resources: extResources, ...props }: IAFileBoxProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -4,46 +4,54 @@ import { TCanCallback } from '../../AUtils/cbF';
 export interface IAFloatMenuActions {
     /**
      * open : () => void
-     * <br/>Description : open AFloatMenu
+     *
+     * Description : open AFloatMenu
      */
     open: () => void;
     /**
      * close : () => void
-     * <br/>Description : close AFloatMenu
+     *
+     * Description : close AFloatMenu
      */
     close: () => void;
     /**
      * toggle : () => void
-     * <br/>Description : toggle AFloatMenu
+     *
+     * Description : toggle AFloatMenu
      */
     toggle: () => void;
 }
 export interface IAFloatMenuContentProps {
     /**
      * defKey : TIdx
-     * <br/>Description : defKey of AFloatMenu
+     *
+     * Description : defKey of AFloatMenu
      */
     defKey: TIdx;
     /**
      * def : IAFloatMenuDef
-     * <br/>Description : def of AFloatMenu
+     *
+     * Description : def of AFloatMenu
      */
     def: IAFloatMenuDef;
 }
 export interface IAFloatMenuDef {
     /**
      * noDisplay? : boolean
-     * <br/>Description : decides whether to display the menu or not
+     *
+     * Description : decides whether to display the menu or not
      */
     noDisplay?: boolean;
     /**
      * isDisabled? : boolean
-     * <br/>Description : decides whether the menu is disabled or not
+     *
+     * Description : decides whether the menu is disabled or not
      */
     isDisabled?: boolean;
     /**
      * content? : TCanCallback<IAFloatMenuContentProps, React.ReactNode>
-     * <br/>Description : content of AFloatMenu
+     *
+     * Description : content of AFloatMenu
      */
     content?: TCanCallback<IAFloatMenuContentProps, React.ReactNode>;
 }
@@ -53,79 +61,55 @@ export type TAFloatMenuDefs = {
 export interface IAFloatMenuProps {
     /**
      * defs : TAFloatMenuDefs
-     * <br/>Description : defs of AFloatMenu
-     * <br/>Basic Usage :
-     * <br/>(1)const defs = {
-     *   'testDefKey' : {
-     *     content : ({defKey, def}) => <div>{defKey}</div>,
-     *   },
-     *   'testDefKey2' : {}
-     * }
-     * return <AFloatMenu defs={defs}/>
+     *
+     * Description : defs of AFloatMenu
      */
     defs: TAFloatMenuDefs;
     /**
      * defaultDef? : IAFloatMenuDef
-     * <br/>Description : defaultDef of AFloatMenu. it will affect all defs.
-     * <br/>Basic Usage :
-     * <br/>(1)const defs = {
-     *   'testDefKey' : {
-     *     content : ({defKey, def}) => <div>{defKey}</div>,
-     *   },
-     *   'testDefKey2' : {}
-     * }
-     * const defaultDef = {
-     *  content : ({defKey, def}) => <div>I am test defaultDef!</div>,
-     * }
-     * return <AFloatMenu defs={defs} defaultDef={defaultDef}/> // testDefKey2 will render 'I am test defaultDef!'
+     *
+     * Description : defaultDef of AFloatMenu. it will affect all defs.
      */
     defaultDef?: IAFloatMenuDef;
     /**
      * anchorRef : React.RefObject<HTMLElement>
-     * <br/>Description : anchorRef of AFloatMenu
-     * <br/>Basic Usage :
-     * <br/>(1)const anchorRef = useRef<HTMLDivElement>(null);
-     * return <>
-     *  <div ref={anchorRef}>I am anchor</div>
-     *  <AFloatMenu anchorRef={anchorRef}/>
-     * </>
+     *
+     * Description : anchorRef of AFloatMenu
      */
     anchorRef: React.RefObject<HTMLElement>;
     /**
      * position? : EDir12
-     * <br/>Description : position of AFloatMenu based on anchorRef
-     * <br/>Basic Usage :
-     * <br/>(1)<AFloatMenu position={EDir12.W}/>
+     *
+     * Description : position of AFloatMenu based on anchorRef
      */
     position?: EDir12;
     /**
      * actionRef? : TActionRef<IAFloatMenuActions>
-     * <br/>Description : actionRef of AFloatMenu
-     * <br/>Basic Usage :
-     * <br/>(1)const actionRef = useRef<IAFloatMenuActions>();
-     * return <AFloatMenu actionRef={actionRef}/>
+     *
+     * Description : actionRef of AFloatMenu
      */
     actionRef?: TActionRef<IAFloatMenuActions>;
 }
 /**
  * AComponent : AFloatMenu
- * <br/>Description : AFloatMenu is a floating component with menues to click.
- * <br/>Basic Usage :
- * <br/>(1)const defs = {
- *  'testDefKey' : {
- *     content : ({defKey, def}) => <div>{defKey}</div>,
- *   },
- *   'testDefKey2' : {}
- * }
- * const defaultDef = {
- *   content : ({defKey, def}) => <div>I am test defaultDef!</div>,
- * }
- * const anchorRef = useRef<HTMLDivElement>(null);
- * return (
- *   <>
- *     <div ref={anchorRef}>I am anchor</div>
- *     <AFloatMenu defs={defs} defaultDef={defaultDef} anchorRef={anchorRef}/>
- *   </>
- * )
+ *
+ * Description : AFloatMenu is a floating component with menues to click.
+ *
+ * Basic Usage :
+ *
+ *     const defs = {
+ *       testDefKey : {
+ *         content : ({defKey, def}) => <div>{defKey}</div>,
+ *       },
+ *       testDefKey2 : {}
+ *     }
+ *     const defaultDef = {
+ *       content : ({defKey, def}) => <div>I am test defaultDef!</div>,
+ *     }
+ *     const anchorRef = useRef<HTMLDivElement>(null);
+ *
+ *     if (case 1)
+ *       <div ref={anchorRef}>I am anchor</div>
+ *       <AFloatMenu defs={defs} defaultDef={defaultDef} anchorRef={anchorRef}/>
  */
 export declare const AFloatMenu: ({ defs: extDefs, defaultDef: extDefaultDef, anchorRef, actionRef, position, }: IAFloatMenuProps) => import("react").ReactPortal | null;

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

@@ -1,44 +1,53 @@
 import { IABaseProps } from '../ABase/ABase';
 /**
  * AComponent : AFrame : RowFrame
- * <br/>Description : RowFrame is a frame component that is displayed as a row and aligned center.
- * <br/>Basic Usage :
- * <br/>(1)<RowFrame>
- *   Items
- *   <div>Item1</div>
- *   <AICon icon="Alert"/>
- * </RowFrame>
+ *
+ * Description : RowFrame is a frame component that is displayed as a row and aligned center.
+ *
+ * Basic Usage :
+ *
+ *     if (case 1)
+ *       <RowFrame>
+ *         Items
+ *         <div>Item1</div>
+ *         <AICon icon="Alert"/>
+ *       </RowFrame>
  */
 export declare const RowFrame: (props: IABaseProps) => import("react/jsx-runtime").JSX.Element;
 /**
  * AComponent : AFrame : ColFrame
- * <br/>Description : ColFrame is a frame component that is displayed as a column and aligned center.
- * <br/>Basic Usage :
- * <br/>(1)<ColFrame>
- *   Items
- *   <div>Item1</div>
- *   <AICon icon="Alert"/>
- * </ColFrame>
+ *
+ * Description : ColFrame is a frame component that is displayed as a column and aligned center.
+ *
+ * Basic Usage :
+ *
+ *     if (case 1)
+ *       <ColFrame>
+ *         Items
+ *         <div>Item1</div>
+ *         <AICon icon="Alert"/>
+ *       </ColFrame>
  */
 export declare const ColFrame: (props: IABaseProps) => import("react/jsx-runtime").JSX.Element;
 interface IOverflowFrameProps extends IABaseProps {
     /**
      * noOverflowTooltip? : boolean
-     * <br/>Description : decides whether to display tooltip when overflowed or not
-     * <br/>Basic Usage :
-     * <br/>(1)<OverflowFrame noOverflowTooltip>
-     *  Long TextTextTextTextTextTextTextTextTextText
-     * </OverflowFrame>
+     *
+     * Description : decides whether to display tooltip when overflowed or not
      */
     noOverflowTooltip?: boolean;
 }
 /**
  * AComponent : AFrame : OverflowFrame
- * <br/>Description : OverflowFrame is a frame component that is text-ellipsis and shows tooltips when overflowed.
- * <br/>Basic Usage :
- * <br/>(1)<OverflowFrame>
- *  Long TextTextTextTextTextTextTextTextTextText
- * </OverflowFrame>
+ *
+ * Description : OverflowFrame is a frame component that is text-ellipsis and shows tooltips when overflowed.
+ *
+ * Basic Usage :
+ *
+ *     if (case 1)
+ *       <OverflowFrame>
+ *         Long TextTextTextTextTextTextTextTextTextText
+ *       </OverflowFrame>
  */
 export declare const OverflowFrame: ({ tooltip: extTooltip, children, abaseRef, className, noOverflowTooltip, ...props }: IOverflowFrameProps) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,11 +1,15 @@
 /**
  * AComponent : AGrow
- * <br/>Description : AGrow is a frame component that grows flexibly.
- * <br/>Basic Usage :
- * <br/>(1)<div style={{display: 'flex', flexGrow: 1}}>
- *   Left Item
- *   <AGrow/>
- *   Right Item
- * </div>
+ *
+ * Description : AGrow is a frame component that grows flexibly.
+ *
+ * Basic Usage :
+ *
+ *     if (case 1)
+ *       <div style={{display: 'flex', flexGrow: 1}}>
+ *         Left Item
+ *         <AGrow/>
+ *         Right Item
+ *       </div>
  */
 export declare const AGrow: () => import("react/jsx-runtime").JSX.Element;

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

@@ -6,17 +6,20 @@ export type TIcons = keyof typeof AIcons;
 export interface IAIconProps extends IASVGProps {
     /**
      * icon : TIcons
-     * <br/>Description : icon to render
-     * <br/>Basic Usage :
-     * <br/>(1)<AIcon icon="Alert"/>
+     *
+     * Description : icon to render
      */
     icon: TIcons;
 }
 /**
  * AComponent : AIcon
- * <br/>Description : AIcon is an icon component that can render icons.
- * <br/>Basic Usage :
- * <br/>(1)<AIcon icon="Alert"/>
+ *
+ * Description : AIcon is an icon component that can render icons.
+ *
+ * Basic Usage :
+ *
+ *     if (case 1)
+ *       <AIcon icon="Alert"/>
  */
 export declare const AIcon: ({ icon, svgRef, ...rest }: IAIconProps) => import("react/jsx-runtime").JSX.Element;
 export declare const AIcons: Readonly<{