ados-rcm 1.0.10 → 1.0.13

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

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