ados-rcm 1.0.9 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/dist/AModule/AComponents/ABase/ABase.d.ts +25 -25
  2. package/dist/AModule/AComponents/AButton/AButton.d.ts +7 -7
  3. package/dist/AModule/AComponents/AButton/AIconButton.d.ts +9 -9
  4. package/dist/AModule/AComponents/ACheckBox/ACheckBox.d.ts +9 -9
  5. package/dist/AModule/AComponents/AClock/AClock.d.ts +19 -19
  6. package/dist/AModule/AComponents/ADatePicker/ADatePicker.d.ts +34 -34
  7. package/dist/AModule/AComponents/ADatePicker/ADateRangePicker.d.ts +9 -9
  8. package/dist/AModule/AComponents/ADialog/ADialog.d.ts +50 -50
  9. package/dist/AModule/AComponents/AFileBox/AFileBox.d.ts +13 -13
  10. package/dist/AModule/AComponents/AFloatMenu/AFloatMenu.d.ts +26 -26
  11. package/dist/AModule/AComponents/AFrames/AFrames.d.ts +12 -12
  12. package/dist/AModule/AComponents/AGrow/AGrow.d.ts +3 -3
  13. package/dist/AModule/AComponents/AIcon/AIcon.d.ts +6 -6
  14. package/dist/AModule/AComponents/AInput/AInput.d.ts +45 -45
  15. package/dist/AModule/AComponents/AListView/AListView.d.ts +16 -16
  16. package/dist/AModule/AComponents/ASelect/ASelect.d.ts +43 -43
  17. package/dist/AModule/AComponents/ASpace/ASpace.d.ts +11 -11
  18. package/dist/AModule/AComponents/AStepper/AStepper.d.ts +20 -20
  19. package/dist/AModule/AComponents/ASwitch/ASwitch.d.ts +7 -7
  20. package/dist/AModule/AComponents/ATab/ATab.d.ts +25 -25
  21. package/dist/AModule/AComponents/ATable/ATable.d.ts +136 -136
  22. package/dist/AModule/AComponents/AText/AText.d.ts +9 -9
  23. package/dist/AModule/AComponents/ATextArea/ATextArea.d.ts +35 -35
  24. package/dist/AModule/AComponents/ATooltip/ATooltip.d.ts +7 -7
  25. package/dist/AModule/AComponents/ATree/ATree.d.ts +31 -31
  26. package/dist/AModule/AComponents/AWrap/AWrap.d.ts +8 -8
  27. package/package.json +1 -1
@@ -5,59 +5,59 @@ export interface IABaseProps extends React.HTMLAttributes<HTMLElement> {
5
5
  children?: React.ReactNode;
6
6
  /**
7
7
  * abaseRef? : React.RefObject<HTMLDivElement>
8
- * Description : ref of ABase *
9
- * Basic Usage :
10
- * (1) const ref = useRef<HtmlDivElement>();
8
+ * <br/>Description : ref of ABase *
9
+ * <br/>Basic Usage :
10
+ * <br/>(1)const ref = useRef<HtmlDivElement>();
11
11
  * <ABase abaseRef={ref}/>
12
12
  */
13
13
  abaseRef?: React.RefObject<HTMLDivElement>;
14
14
  /**
15
15
  * isDisabled? : any
16
- * Description : if truthy, dimming is applied. if isLoading is true, spinner is dimmed as well.
17
- * Basic Usage :
18
- * (1) <ABase isDisabled/>
16
+ * <br/>Description : if truthy, dimming is applied. if isLoading is true, spinner is dimmed as well.
17
+ * <br/>Basic Usage :
18
+ * <br/>(1)<ABase isDisabled/>
19
19
  */
20
20
  isDisabled?: any;
21
21
  /**
22
22
  * isLoading? : any
23
- * Description : if truthy, dimming and spinner are applied.
24
- * Basic Usage :
25
- * (1) <ABase isLoading/>
23
+ * <br/>Description : if truthy, dimming and spinner are applied.
24
+ * <br/>Basic Usage :
25
+ * <br/>(1)<ABase isLoading/>
26
26
  */
27
27
  isLoading?: any;
28
28
  /**
29
29
  * tooltip? : React.ReactNode
30
- * Description : tooltip. if tooltip is truthy, tooltip is shown.
31
- * Basic Usage :
32
- * (1) <ABase tooltip="tooltip text"/>
33
- * (2) <ABase tooltip={<div>tooltip text</div>}/>
30
+ * <br/>Description : tooltip. if tooltip is truthy, tooltip is shown.
31
+ * <br/>Basic Usage :
32
+ * <br/>(1)<ABase tooltip="tooltip text"/>
33
+ * <br/>(2)<ABase tooltip={<div>tooltip text</div>}/>
34
34
  */
35
35
  tooltip?: React.ReactNode;
36
36
  /**
37
37
  * tooltipDistance? : number = 10
38
- * Description : distance in pixels between tooltip and target.
39
- * Basic Usage :
40
- * (1) <ABase tooltipDistance={10}/>
38
+ * <br/>Description : distance in pixels between tooltip and target.
39
+ * <br/>Basic Usage :
40
+ * <br/>(1)<ABase tooltipDistance={10}/>
41
41
  */
42
42
  tooltipDistance?: number;
43
43
  /**
44
44
  * tooltipDelay? : number
45
- * Description : delay in seconds of tooltip after mouse enter.
46
- * Basic Usage :
47
- * (1) <ABase tooltipDelay={100}/>
45
+ * <br/>Description : delay in seconds of tooltip after mouse enter.
46
+ * <br/>Basic Usage :
47
+ * <br/>(1)<ABase tooltipDelay={100}/>
48
48
  */
49
49
  tooltipDelay?: number;
50
50
  }
51
51
  /**
52
52
  * AComponent : ABase
53
- * Description : ABase is a base component(like div) that can have isDisabled, isLoading and tooltip.
54
- * Basic Usage :
55
- * (1) return <ABase>{children}</ABase>
53
+ * <br/>Description : ABase is a base component(like div) that can have isDisabled, isLoading and tooltip.
54
+ * <br/>Basic Usage :
55
+ * <br/>(1)return <ABase>{children}</ABase>
56
56
  *
57
- * (2) return <ABase isDisabled>{children}</ABase>
57
+ * <br/>(2)return <ABase isDisabled>{children}</ABase>
58
58
  *
59
- * (3) return <ABase isLoading>{children}</ABase>
59
+ * <br/>(3)return <ABase isLoading>{children}</ABase>
60
60
  *
61
- * (4) return <ABase tooltip="tooltip text">{children}</ABase>
61
+ * <br/>(4)return <ABase tooltip="tooltip text">{children}</ABase>
62
62
  */
63
63
  export declare const ABase: (props: IABaseProps) => React.ReactNode;
@@ -4,18 +4,18 @@ export type TAButtonType = 'Primary' | 'Secondary' | 'Undefined';
4
4
  export interface IAButtonProps extends IABaseProps, IAWrapProps {
5
5
  /**
6
6
  * type? : TAButtonType = 'Primary'
7
- * Description : type of IAButton
8
- * Basic Usage :
9
- * (1) <AButton type="Secondary"/>
7
+ * <br/>Description : type of IAButton
8
+ * <br/>Basic Usage :
9
+ * <br/>(1)<AButton type="Secondary"/>
10
10
  */
11
11
  type?: TAButtonType;
12
12
  }
13
13
  /**
14
14
  * AComponent : AButton
15
- * Description : AButton is a button component.
16
- * Basic Usage :
17
- * (1) <AButton onClick={onClick}>Click Me</AButton>
15
+ * <br/>Description : AButton is a button component.
16
+ * <br/>Basic Usage :
17
+ * <br/>(1)<AButton onClick={onClick}>Click Me</AButton>
18
18
  *
19
- * (2) <AButton type="Secondary" onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'Button Disabled'}>Click Me</AButton>
19
+ * <br/>(2)<AButton type="Secondary" onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'Button Disabled'}>Click Me</AButton>
20
20
  */
21
21
  export declare const AButton: (props: IAButtonProps) => import("react/jsx-runtime").JSX.Element;
@@ -3,24 +3,24 @@ import { TIcons } from '../AIcon/AIcon';
3
3
  interface IAIconButtonProps extends IABaseProps {
4
4
  /**
5
5
  * icon : TIcons
6
- * Description : icon of AIconButton
7
- * Basic Usage :
8
- * (1) <AIconButton icon="Alert"/>
6
+ * <br/>Description : icon of AIconButton
7
+ * <br/>Basic Usage :
8
+ * <br/>(1)<AIconButton icon="Alert"/>
9
9
  */
10
10
  icon: TIcons;
11
11
  /**
12
12
  * size? : 'Small' | 'Medium' | 'Large' = 'Medium'
13
- * Description : size of AIconButton
14
- * Basic Usage :
15
- * (1) <AIconButton icon="Alert" size="Small"/>
13
+ * <br/>Description : size of AIconButton
14
+ * <br/>Basic Usage :
15
+ * <br/>(1)<AIconButton icon="Alert" size="Small"/>
16
16
  */
17
17
  size?: 'Small' | 'Medium' | 'Large';
18
18
  }
19
19
  /**
20
20
  * AComponent : AIconButton
21
- * Description : AIconButton is a button component with an Icon.
22
- * Basic Usage :
23
- * (1) <AIconButton icon="Alert" size="Small" onClick={onClick}/>
21
+ * <br/>Description : AIconButton is a button component with an Icon.
22
+ * <br/>Basic Usage :
23
+ * <br/>(1)<AIconButton icon="Alert" size="Small" onClick={onClick}/>
24
24
  */
25
25
  export declare const AIconButton: (props: IAIconButtonProps) => import("react/jsx-runtime").JSX.Element;
26
26
  export {};
@@ -3,25 +3,25 @@ import { IABaseProps } from '../ABase/ABase';
3
3
  export interface IACheckBoxProps extends IABaseProps {
4
4
  /**
5
5
  * useCheck? : TUseValues<any>
6
- * Description : [useCheck, setUseCheck] = useValues of ACheckBox. if useCheck is truthy, ACheckBox is checked.
7
- * Basic Usage :
8
- * (1) const [useCheck, setUseCheck] = useState(false);
6
+ * <br/>Description : [useCheck, setUseCheck] = useValues of ACheckBox. if useCheck is truthy, ACheckBox is checked.
7
+ * <br/>Basic Usage :
8
+ * <br/>(1)const [useCheck, setUseCheck] = useState(false);
9
9
  * <ACheckBox useCheck={[useCheck, setUseCheck]}/>
10
10
  */
11
11
  useCheck?: TUseValues<any>;
12
12
  /**
13
13
  * isIndeterminate? : boolean
14
- * Description : if true, ACheckBox is indeterminate. priority is higher than useCheck.
15
- * Basic Usage :
16
- * (1) <ACheckBox isIndeterminate/>
14
+ * <br/>Description : if true, ACheckBox is indeterminate. priority is higher than useCheck.
15
+ * <br/>Basic Usage :
16
+ * <br/>(1)<ACheckBox isIndeterminate/>
17
17
  */
18
18
  isIndeterminate?: boolean;
19
19
  }
20
20
  /**
21
21
  * AComponent : ACheckBox
22
- * Description : ACheckBox is a checkbox component.
23
- * Basic Usage :
24
- * (1) const [useCheck, setUseCheck] = useState(false);
22
+ * <br/>Description : ACheckBox is a checkbox component.
23
+ * <br/>Basic Usage :
24
+ * <br/>(1)const [useCheck, setUseCheck] = useState(false);
25
25
  * <ACheckBox useCheck={[useCheck, setUseCheck]} onClick={onClick} isDisabled={isDisabled} tooltip={isDisabled && 'CheckBox Disabled'} />
26
26
  */
27
27
  export declare const ACheckBox: ({ useCheck, isIndeterminate, ...abaseProps }: IACheckBoxProps) => React.ReactNode;
@@ -5,61 +5,61 @@ import { TActionRef } from '../ATypes/ATypes';
5
5
  export interface IAClockActions {
6
6
  /**
7
7
  * start : () => void
8
- * Description : start clock running
8
+ * <br/>Description : start clock running
9
9
  */
10
10
  start: () => void;
11
11
  /**
12
12
  * stop : () => void
13
- * Description : stop clock running
13
+ * <br/>Description : stop clock running
14
14
  */
15
15
  stop: () => void;
16
16
  /**
17
17
  * reset : () => void
18
- * Description : set clock's tick to maxTicks and stop clock running
18
+ * <br/>Description : set clock's tick to maxTicks and stop clock running
19
19
  */
20
20
  reset: () => void;
21
21
  /**
22
22
  * setTicks : (ticks: number) => void
23
- * Description : set clock's tick to specified number
23
+ * <br/>Description : set clock's tick to specified number
24
24
  */
25
25
  setTicks: (ticks: number) => void;
26
26
  }
27
27
  export interface IAClockProps extends IAWrapProps, IABaseProps {
28
28
  /**
29
29
  * maxTicks? : number = 300
30
- * Description : maxTicks of AClock
31
- * Basic Usage :
32
- * (1) <AClock maxTicks={180}/>
30
+ * <br/>Description : maxTicks of AClock
31
+ * <br/>Basic Usage :
32
+ * <br/>(1)<AClock maxTicks={180}/>
33
33
  */
34
34
  maxTicks?: number;
35
35
  /**
36
36
  * interval? : number = 1000
37
- * Description : interval in milliseconds of AClock
38
- * Basic Usage :
39
- * (1) <AClock interval={500}/>
37
+ * <br/>Description : interval in milliseconds of AClock
38
+ * <br/>Basic Usage :
39
+ * <br/>(1)<AClock interval={500}/>
40
40
  */
41
41
  interval?: number;
42
42
  /**
43
43
  * onFinish? : () => void
44
- * Description : onFinish of AClock
45
- * Basic Usage :
46
- * (1) <AClock onFinish={onFinish}/>
44
+ * <br/>Description : onFinish of AClock
45
+ * <br/>Basic Usage :
46
+ * <br/>(1)<AClock onFinish={onFinish}/>
47
47
  */
48
48
  onFinish?: () => void;
49
49
  /**
50
50
  * actionRef? : TActionRef<IAClockActions>
51
- * Description : actionRef of AClock
52
- * Basic Usage :
53
- * (1) const actionRef = useRef<IAClockActions>();
51
+ * <br/>Description : actionRef of AClock
52
+ * <br/>Basic Usage :
53
+ * <br/>(1)const actionRef = useRef<IAClockActions>();
54
54
  * <AClock actionRef={ref}/>
55
55
  */
56
56
  actionRef?: TActionRef<IAClockActions>;
57
57
  }
58
58
  /**
59
59
  * AComponent : AClock
60
- * Description : AClock is a clock component.
61
- * Basic Usage :
62
- * (1) const actionRef = useRef<IAClockActions>();
60
+ * <br/>Description : AClock is a clock component.
61
+ * <br/>Basic Usage :
62
+ * <br/>(1)const actionRef = useRef<IAClockActions>();
63
63
  * const onStartClick = () => {
64
64
  * actionRef.current?.start();
65
65
  * }
@@ -5,35 +5,35 @@ import { Resources } from '../AResource/AResource';
5
5
  export interface IADatePickerActions {
6
6
  /**
7
7
  * open : () => void
8
- * Description : opens calendar when called
8
+ * <br/>Description : opens calendar when called
9
9
  */
10
10
  open: () => void;
11
11
  /**
12
12
  * close : () => void
13
- * Description : closes calendar when called
13
+ * <br/>Description : closes calendar when called
14
14
  */
15
15
  close: () => void;
16
16
  /**
17
17
  * toggle : () => void
18
- * Description : toggles calendar(open <> close) when called
18
+ * <br/>Description : toggles calendar(open <> close) when called
19
19
  */
20
20
  toggle: () => void;
21
21
  }
22
22
  export interface IADatePickerProps {
23
23
  /**
24
24
  * className? : string
25
- * Description : className of ADatePicker
26
- * Basic Usage :
27
- * (1) <ADatePicker className="className"/>
25
+ * <br/>Description : className of ADatePicker
26
+ * <br/>Basic Usage :
27
+ * <br/>(1)<ADatePicker className="className"/>
28
28
  */
29
29
  className?: string;
30
30
  /**
31
31
  * useDate? : TUseValues<Date>
32
- * Description : useDate of ADatePicker
33
- * Basic Usage :
34
- * (1) const [date, setDate] = useState(new Date());
32
+ * <br/>Description : useDate of ADatePicker
33
+ * <br/>Basic Usage :
34
+ * <br/>(1)const [date, setDate] = useState(new Date());
35
35
  * <ADatePicker useDate={[date, setDate]}/>
36
- * (2) const [date, setDate] = useState(new Date());
36
+ * <br/>(2)const [date, setDate] = useState(new Date());
37
37
  * const onDateChange = (newDate: Date) => {
38
38
  * setDate(newDate);
39
39
  * }
@@ -42,16 +42,16 @@ export interface IADatePickerProps {
42
42
  useDate?: TUseValues<Date>;
43
43
  /**
44
44
  * position? : EDir12 = EDir12.SE
45
- * Description : position of calendar
46
- * Basic Usage :
47
- * (1) <ADatePicker position={EDir12.E}/>
45
+ * <br/>Description : position of calendar
46
+ * <br/>Basic Usage :
47
+ * <br/>(1)<ADatePicker position={EDir12.E}/>
48
48
  */
49
49
  position?: EDir12;
50
50
  /**
51
51
  * actionRef? : TActionRef<IADatePickerActions>
52
- * Description : actionRef of ADatePicker
53
- * Basic Usage :
54
- * (1) const actionRef = useRef<IADatePickerActions>();
52
+ * <br/>Description : actionRef of ADatePicker
53
+ * <br/>Basic Usage :
54
+ * <br/>(1)const actionRef = useRef<IADatePickerActions>();
55
55
  * return (
56
56
  * <>
57
57
  * <ADatePicker actionRef={ref}/>
@@ -62,45 +62,45 @@ export interface IADatePickerProps {
62
62
  actionRef?: TActionRef<IADatePickerActions>;
63
63
  /**
64
64
  * minDate? : Date = new Date(new Date().getFullYear() - 1, new Date().getMonth(), new Date().getDate())
65
- * Description : minimum date of ADatePicker. default is a year ago from now
66
- * Basic Usage :
67
- * (1) <ADatePicker minDate={new Date(2021, 0, 1)}/>
65
+ * <br/>Description : minimum date of ADatePicker. default is a year ago from now
66
+ * <br/>Basic Usage :
67
+ * <br/>(1)<ADatePicker minDate={new Date(2021, 0, 1)}/>
68
68
  */
69
69
  minDate?: Date;
70
70
  /**
71
71
  * maxDate? : Date = new Date(new Date().getFullYear() + 1, new Date().getMonth(), new Date().getDate())
72
- * Description : maximum date of ADatePicker. default is a year later from now
73
- * Basic Usage :
74
- * (1) <ADatePicker maxDate={new Date(2022, 0, 1)}/>
72
+ * <br/>Description : maximum date of ADatePicker. default is a year later from now
73
+ * <br/>Basic Usage :
74
+ * <br/>(1)<ADatePicker maxDate={new Date(2022, 0, 1)}/>
75
75
  */
76
76
  maxDate?: Date;
77
77
  /**
78
78
  * resources? : Partial<typeof Resources.ADatePicker>
79
- * Description : language resources of ADatePicker
80
- * Basic Usage :
81
- * (1) <ADatePicker resources={{months: (x) => 'current month :' + x}}/>
79
+ * <br/>Description : language resources of ADatePicker
80
+ * <br/>Basic Usage :
81
+ * <br/>(1)<ADatePicker resources={{months: (x) => 'current month :' + x}}/>
82
82
  */
83
83
  resources?: Partial<typeof Resources.ADatePicker>;
84
84
  /**
85
85
  * LeftAddon? : React.ReactNode
86
- * Description : LeftAddon of ADatePicker
87
- * Basic Usage :
88
- * (1) <ADatePicker LeftAddon={<AIcon icon="Alert"/>}/>
86
+ * <br/>Description : LeftAddon of ADatePicker
87
+ * <br/>Basic Usage :
88
+ * <br/>(1)<ADatePicker LeftAddon={<AIcon icon="Alert"/>}/>
89
89
  */
90
90
  LeftAddon?: React.ReactNode;
91
91
  /**
92
92
  * RightAddon? : React.ReactNode
93
- * Description : RightAddon of ADatePicker
94
- * Basic Usage :
95
- * (1) <ADatePicker RightAddon={<AIcon icon="Alert"/>}/>
93
+ * <br/>Description : RightAddon of ADatePicker
94
+ * <br/>Basic Usage :
95
+ * <br/>(1)<ADatePicker RightAddon={<AIcon icon="Alert"/>}/>
96
96
  */
97
97
  RightAddon?: React.ReactNode;
98
98
  }
99
99
  /**
100
100
  * AComponent : ADatePicker
101
- * Description : ADatePicker is a component for selecting single date.
102
- * Basic Usage :
103
- * (1) const actionRef = useRef<IADatePickerActions>();
101
+ * <br/>Description : ADatePicker is a component for selecting single date.
102
+ * <br/>Basic Usage :
103
+ * <br/>(1)const actionRef = useRef<IADatePickerActions>();
104
104
  * const [date, setDate] = useState(new Date());
105
105
  * return (
106
106
  * <>
@@ -3,23 +3,23 @@ import { IADatePickerProps } from './ADatePicker';
3
3
  export interface IDateRange {
4
4
  /**
5
5
  * sDate : Date;
6
- * Description : start date of IDateRange
6
+ * <br/>Description : start date of IDateRange
7
7
  */
8
8
  sDate: Date;
9
9
  /**
10
10
  * eDate : Date;
11
- * Description : end date of IDateRange
11
+ * <br/>Description : end date of IDateRange
12
12
  */
13
13
  eDate: Date;
14
14
  }
15
15
  export interface IADateRangePickerProps extends Omit<IADatePickerProps, 'useDate'> {
16
16
  /**
17
17
  * useDateRange : TUseValues<IDateRange>;
18
- * Description : useDateRange of ADateRangePicker
19
- * Basic Usage :
20
- * (1) const [useDateRange, setUseDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
18
+ * <br/>Description : useDateRange of ADateRangePicker
19
+ * <br/>Basic Usage :
20
+ * <br/>(1)const [useDateRange, setUseDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
21
21
  * return <ADateRangePicker useDateRange={[useDateRange, setUseDateRange]} />
22
- * (2) const useDateRange = useValues<IDateRange>({ sDate: new Date(), eDate: new Date() });
22
+ * <br/>(2)const useDateRange = useValues<IDateRange>({ sDate: new Date(), eDate: new Date() });
23
23
  * const onDateRangeChange = (newDateRange: IDateRange) => {
24
24
  * setUseDateRange(newDateRange);
25
25
  * };
@@ -29,9 +29,9 @@ export interface IADateRangePickerProps extends Omit<IADatePickerProps, 'useDate
29
29
  }
30
30
  /**
31
31
  * AComponent : ADateRangePicker
32
- * Description : ADateRangePicker is a component for selecting dateRange
33
- * Basic Usage :
34
- * (1) const actionRef = useRef<IADatePickerActions>();
32
+ * <br/>Description : ADateRangePicker is a component for selecting dateRange
33
+ * <br/>Basic Usage :
34
+ * <br/>(1)const actionRef = useRef<IADatePickerActions>();
35
35
  * const [dateRange, setDateRange] = useState<IDateRange>({ sDate: new Date(), eDate: new Date() });
36
36
  * return (
37
37
  * <>
@@ -9,27 +9,27 @@ import { IAEventCallers, TActionRef } from '../ATypes/ATypes';
9
9
  export interface IADialogActions {
10
10
  /**
11
11
  * open : () => void
12
- * Description : open dialog
12
+ * <br/>Description : open dialog
13
13
  */
14
14
  open: () => void;
15
15
  /**
16
16
  * close : () => void
17
- * Description : close dialog
17
+ * <br/>Description : close dialog
18
18
  */
19
19
  close: () => void;
20
20
  /**
21
21
  * toggle : () => void
22
- * Description : toggle dialog
22
+ * <br/>Description : toggle dialog
23
23
  */
24
24
  toggle: () => void;
25
25
  /**
26
26
  * ok : () => void
27
- * Description : run ok of the dialog
27
+ * <br/>Description : run ok of the dialog
28
28
  */
29
29
  ok: () => void;
30
30
  /**
31
31
  * cancel : () => void
32
- * Description : run cancel of the dialog
32
+ * <br/>Description : run cancel of the dialog
33
33
  */
34
34
  cancel: () => void;
35
35
  }
@@ -37,101 +37,101 @@ export type TADialogTypes = 'okCancel' | 'cancelOk' | 'ok' | 'cancel' | 'none';
37
37
  export interface IADialogProps {
38
38
  /**
39
39
  * type? : TADialogTypes = 'okCancel'
40
- * Description : type of dialog. decides the type of action buttons
41
- * Basic Usage :
42
- * (1) <ADialog type='cancelOk'/>
40
+ * <br/>Description : type of dialog. decides the type of action buttons
41
+ * <br/>Basic Usage :
42
+ * <br/>(1)<ADialog type='cancelOk'/>
43
43
  */
44
44
  type?: TADialogTypes;
45
45
  /**
46
46
  * title? : React.ReactNode
47
- * Description : title of the dialog
48
- * Basic Usage :
49
- * (1) <ADialog title='Title'/>
47
+ * <br/>Description : title of the dialog
48
+ * <br/>Basic Usage :
49
+ * <br/>(1)<ADialog title='Title'/>
50
50
  */
51
51
  title?: React.ReactNode;
52
52
  /**
53
53
  * actionRef? : TActionRef<IADialogActions>
54
- * Description : actionRef of the dialog
55
- * Basic Usage :
56
- * (1) const actionRef = useRef<IADialogActions>();
54
+ * <br/>Description : actionRef of the dialog
55
+ * <br/>Basic Usage :
56
+ * <br/>(1)const actionRef = useRef<IADialogActions>();
57
57
  * return <ADialog actionRef={ref}/>
58
58
  */
59
59
  actionRef?: TActionRef<IADialogActions>;
60
60
  /**
61
61
  * children? : React.ReactNode
62
- * Description : children of the dialog
63
- * Basic Usage :
64
- * (1) <ADialog>children</ADialog>
62
+ * <br/>Description : children of the dialog
63
+ * <br/>Basic Usage :
64
+ * <br/>(1)<ADialog>children</ADialog>
65
65
  */
66
66
  children?: React.ReactNode;
67
67
  /**
68
68
  * onOk : (e: IAEventCallers) => void;
69
- * Description : onOk of the dialog. it closes the dialog by default
70
- * Basic Usage :
71
- * (1) <ADialog onOk={onOk}/>
72
- * (2) <ADialog onOk={(e) => e.preventDefault()}/>
69
+ * <br/>Description : onOk of the dialog. it closes the dialog by default
70
+ * <br/>Basic Usage :
71
+ * <br/>(1)<ADialog onOk={onOk}/>
72
+ * <br/>(2)<ADialog onOk={(e) => e.preventDefault()}/>
73
73
  */
74
74
  onOk?: (e: IAEventCallers) => void;
75
75
  /**
76
76
  * onCancel : (e: IAEventCallers) => void;
77
- * Description : onCancel of the dialog. it closes the dialog by default
78
- * Basic Usage :
79
- * (1) <ADialog onCancel={onCancel}/>
80
- * (2) <ADialog onCancel={(e) => e.preventDefault()}/>
77
+ * <br/>Description : onCancel of the dialog. it closes the dialog by default
78
+ * <br/>Basic Usage :
79
+ * <br/>(1)<ADialog onCancel={onCancel}/>
80
+ * <br/>(2)<ADialog onCancel={(e) => e.preventDefault()}/>
81
81
  */
82
82
  onCancel?: (e: IAEventCallers) => void;
83
83
  /**
84
84
  * onEnterPress : (e: IAEventCallers) => void;
85
- * Description : onEnterPress of the dialog. it runs ok by default
86
- * Basic Usage :
87
- * (1) <ADialog onEnterPress={onEnterPress}/>
88
- * (2) <ADialog onEnterPress={(e) => e.preventDefault()}/>
85
+ * <br/>Description : onEnterPress of the dialog. it runs ok by default
86
+ * <br/>Basic Usage :
87
+ * <br/>(1)<ADialog onEnterPress={onEnterPress}/>
88
+ * <br/>(2)<ADialog onEnterPress={(e) => e.preventDefault()}/>
89
89
  */
90
90
  onEnterPress?: (e: IAEventCallers) => void;
91
91
  /**
92
92
  * onEscPress : (e: IAEventCallers) => void;
93
- * Description : onEscPress of the dialog. it runs cancel by default
94
- * Basic Usage :
95
- * (1) <ADialog onEscPress={onEscPress}/>
96
- * (2) <ADialog onEscPress={(e) => e.preventDefault()}/>
93
+ * <br/>Description : onEscPress of the dialog. it runs cancel by default
94
+ * <br/>Basic Usage :
95
+ * <br/>(1)<ADialog onEscPress={onEscPress}/>
96
+ * <br/>(2)<ADialog onEscPress={(e) => e.preventDefault()}/>
97
97
  */
98
98
  onEscPress?: (e: IAEventCallers) => void;
99
99
  /**
100
100
  * onSpacePress : (e: IAEventCallers) => void;
101
- * Description : onSpacePress of the dialog. it runs ok by default
102
- * Basic Usage :
103
- * (1) <ADialog onSpacePress={onSpacePress}/>
104
- * (2) <ADialog onSpacePress={(e) => e.preventDefault()}/>
101
+ * <br/>Description : onSpacePress of the dialog. it runs ok by default
102
+ * <br/>Basic Usage :
103
+ * <br/>(1)<ADialog onSpacePress={onSpacePress}/>
104
+ * <br/>(2)<ADialog onSpacePress={(e) => e.preventDefault()}/>
105
105
  */
106
106
  onSpacePress?: (e: IAEventCallers) => void;
107
107
  /**
108
108
  * onPaperClick : (e: IAEventCallers) => void;
109
- * Description : onPaperClick of the dialog. it runs cancel by default
110
- * Basic Usage :
111
- * (1) <ADialog onPaperClick={onPaperClick}/>
112
- * (2) <ADialog onPaperClick={(e) => e.preventDefault()}/>
109
+ * <br/>Description : onPaperClick of the dialog. it runs cancel by default
110
+ * <br/>Basic Usage :
111
+ * <br/>(1)<ADialog onPaperClick={onPaperClick}/>
112
+ * <br/>(2)<ADialog onPaperClick={(e) => e.preventDefault()}/>
113
113
  */
114
114
  onPaperClick?: (e: IAEventCallers) => void;
115
115
  /**
116
116
  * noDim? : boolean = false
117
- * Description : decides whether the dialog has dim or not
118
- * Basic Usage :
119
- * (1) <ADialog noDim/>
117
+ * <br/>Description : decides whether the dialog has dim or not
118
+ * <br/>Basic Usage :
119
+ * <br/>(1)<ADialog noDim/>
120
120
  */
121
121
  noDim?: boolean;
122
122
  /**
123
123
  * resources? : Partial<typeof Resources.ADialog>
124
- * Description : language resources of the dialog
125
- * Basic Usage :
126
- * (1) <ADialog resources={{ ok: "I'm ok", cancel: "I'm Cancel" }}/>
124
+ * <br/>Description : language resources of the dialog
125
+ * <br/>Basic Usage :
126
+ * <br/>(1)<ADialog resources={{ ok: "I'm ok", cancel: "I'm Cancel" }}/>
127
127
  */
128
128
  resources?: Partial<typeof Resources.ADialog>;
129
129
  }
130
130
  /**
131
131
  * AComponent : ADialog
132
- * Description : ADialog is a dialog component.
133
- * Basic Usage :
134
- * (1) const actionRef = useRef<IADialogActions>();
132
+ * <br/>Description : ADialog is a dialog component.
133
+ * <br/>Basic Usage :
134
+ * <br/>(1)const actionRef = useRef<IADialogActions>();
135
135
  * const onOk = () => {
136
136
  * console.log('ok');
137
137
  * }