@baton8/general-components 1.2.0-alpha.4 → 1.2.0-alpha.5

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.
@@ -30,6 +30,13 @@ export declare const Textarea: import("react").ForwardRefExoticComponent<import(
30
30
  autoComplete?: string | undefined;
31
31
  /** */
32
32
  autoFocus?: boolean | undefined;
33
+ /**
34
+ * 右端で入力テキストが折り返されるかどうか。
35
+ * - `true` — 右端でテキストが折り返されます。
36
+ * - `false` — 右端でテキストは折り返されず、水平スクロールバーが表示されます。
37
+ * @defaultValue `true`
38
+ */
39
+ isWrapped?: boolean | undefined;
33
40
  /**
34
41
  * バリデーションエラーがあるかどうか。
35
42
  * これが `true` のときは警告表示になります。
@@ -15,9 +15,9 @@ export declare const CardTitle: import("react").ForwardRefExoticComponent<import
15
15
  as?: keyof JSX.IntrinsicElements | undefined;
16
16
  /**
17
17
  * 最大行数。
18
- * @defaultValue `4`
18
+ * @defaultValue `null`
19
19
  */
20
- maxLineHeight?: number | undefined;
20
+ maxLineCount?: number | undefined;
21
21
  /** */
22
22
  className?: string | undefined;
23
23
  /** */
@@ -1,40 +1,28 @@
1
- import { MouseEvent, ReactNode } from "react";
1
+ /// <reference types="react" />
2
2
  /**
3
+ * @deprecated
4
+ * 代わりに `Button` を利用してください。
5
+ *
3
6
  * @group React コンポーネント
4
7
  * @category React コンポーネント
5
8
  */
6
- export declare const DialogButton: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
9
+ export declare const DialogButton: import("react").ForwardRefExoticComponent<import("../../..").DataProps<string> & {
7
10
  className?: string | undefined;
8
11
  id?: string | undefined;
9
12
  style?: import("react").CSSProperties | undefined;
10
- } & {
11
- /**
12
- * 見た目のバリアント。
13
- * そのダイアログに関するメインの動作を行うボタンには `"submit"` を指定し、それ以外のキャンセルボタンなどには `"cancel"` を指定してください。
14
- * @defaultValue `"submit"`
15
- */
16
- variant?: "submit" | "cancel" | undefined;
17
- /**
18
- * 無効にするかどうか。
19
- *
20
- * `onClick` に文字列値が指定されていてリンクとして表示される際は、これは無視されます。
21
- * @defaultValue `false`
22
- */
13
+ } & import("react").AriaAttributes & {
14
+ scheme?: "primary" | "secondary" | "blue" | "red" | "green" | "pink" | "yellow" | "purple" | "orange" | "gray" | "gold" | "silver" | "bronze" | undefined;
15
+ variant?: "solid" | "light" | "underline" | "simple" | "unstyledUnderline" | "unstyledSimple" | undefined;
16
+ size?: "small" | "medium" | "large" | undefined;
17
+ isCompact?: boolean | undefined;
18
+ type?: "button" | "reset" | "submit" | undefined;
23
19
  isDisabled?: boolean | undefined;
24
- /**
25
- * ローディング中かどうか。
26
- * これが `true` の間は、ボタンがローディング表示され無効になります。
27
- * @defaultValue `false`
28
- */
29
20
  isLoading?: boolean | undefined;
30
- /**
31
- * クリックされたときに実行する関数。
32
- */
33
- onClick?: ((event: MouseEvent<HTMLButtonElement>) => void) | undefined;
34
- /**
35
- * ボタンの内部に表示する内容。
36
- */
37
- children?: ReactNode;
38
- /** */
21
+ onClick?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
22
+ onKeyDown?: ((event: import("react").KeyboardEvent<HTMLButtonElement>) => unknown) | undefined;
23
+ onKeyUp?: ((event: import("react").KeyboardEvent<HTMLButtonElement>) => unknown) | undefined;
24
+ onMouseDown?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
25
+ onPointerDown?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
26
+ children?: import("react").ReactNode;
39
27
  className?: string | undefined;
40
28
  } & import("react").RefAttributes<HTMLButtonElement>>;
@@ -4,7 +4,7 @@ import { ReactNode } from "react";
4
4
  * @category React コンポーネント
5
5
  */
6
6
  export declare const DialogFooter: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
7
- className?: string | undefined;
7
+ className?: string | undefined; /** */
8
8
  id?: string | undefined;
9
9
  style?: import("react").CSSProperties | undefined;
10
10
  } & {
@@ -25,6 +25,18 @@ type DrawerProps = CommonProps & {
25
25
  children: ReactNode;
26
26
  };
27
27
  /**
28
+ * ### ドロワー
29
+ *
30
+ * #### 構成
31
+ * 以下のようなコンポーネント構成で利用してください。
32
+ * - **`Drawer`**
33
+ * - [`DrawerHeader`](/docs/modules-Drawer-DrawerHeader--ドキュメント) (任意)
34
+ * - [`DrawerHeaderLeft`](/docs/modules-Drawer-DrawerHeaderLeft--ドキュメント)
35
+ * - [`DrawerHeaderTitle`](/docs/modules-Drawer-DrawerHeaderTitle--ドキュメント)
36
+ * - [`DrawerHeaderCaption`](/docs/modules-Drawer-DrawerHeaderCaption--ドキュメント) (任意)
37
+ * - [`DrawerHeaderRight`](/docs/modules-Drawer-DrawerHeaderRight--ドキュメント)
38
+ * - [`DrawerBody`](/docs/modules-Drawer-DrawerBody--ドキュメント)
39
+ *
28
40
  * @group React コンポーネント
29
41
  * @category React コンポーネント
30
42
  */
@@ -10,6 +10,4 @@ export declare const DrawerBody: import("react").ForwardRefExoticComponent<impor
10
10
  } & {
11
11
  /** */
12
12
  children: ReactNode;
13
- /** */
14
- className?: string | undefined;
15
13
  } & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,42 +1,28 @@
1
- import { MouseEvent, ReactNode } from "react";
1
+ /// <reference types="react" />
2
2
  /**
3
+ * @deprecated
4
+ * 代わりに `Button` を利用してください。
5
+ *
3
6
  * @group React コンポーネント
4
7
  * @category React コンポーネント
5
8
  */
6
- export declare const DrawerButton: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
9
+ export declare const DrawerButton: import("react").ForwardRefExoticComponent<import("../../..").DataProps<string> & {
7
10
  className?: string | undefined;
8
11
  id?: string | undefined;
9
12
  style?: import("react").CSSProperties | undefined;
10
- } & {
11
- /**
12
- * 見た目のバリアント。
13
- * そのダイアログに関するメインの動作を行うボタンには `"submit"` を指定し、それ以外のキャンセルボタンなどには `"cancel"` を指定してください。
14
- * @defaultValue `"submit"`
15
- */
16
- variant?: "submit" | "cancel" | undefined;
17
- /**
18
- * 無効にするかどうか。
19
- *
20
- * `onClick` に文字列値が指定されていてリンクとして表示される際は、これは無視されます。
21
- * @defaultValue `false`
22
- */
13
+ } & import("react").AriaAttributes & {
14
+ scheme?: "primary" | "secondary" | "blue" | "red" | "green" | "pink" | "yellow" | "purple" | "orange" | "gray" | "gold" | "silver" | "bronze" | undefined;
15
+ variant?: "solid" | "light" | "underline" | "simple" | "unstyledUnderline" | "unstyledSimple" | undefined;
16
+ size?: "small" | "medium" | "large" | undefined;
17
+ isCompact?: boolean | undefined;
18
+ type?: "button" | "reset" | "submit" | undefined;
23
19
  isDisabled?: boolean | undefined;
24
- /**
25
- * ローディング中かどうか。
26
- * これが `true` の間は、ボタンがローディング表示され無効になります。
27
- * @defaultValue `false`
28
- */
29
20
  isLoading?: boolean | undefined;
30
- /**
31
- * クリックされたときに実行する関数。
32
- * URL 文字列を指定すると、指定された URL に遷移する `<a>` 要素として表示されます。
33
- * 関数を指定すると、その関数を実行する `<button>` 要素として表示されます。
34
- */
35
- onClick?: string | ((event: MouseEvent<HTMLButtonElement>) => void) | undefined;
36
- /**
37
- * ボタンの内部に表示する内容。
38
- */
39
- children?: ReactNode;
40
- /** */
21
+ onClick?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
22
+ onKeyDown?: ((event: import("react").KeyboardEvent<HTMLButtonElement>) => unknown) | undefined;
23
+ onKeyUp?: ((event: import("react").KeyboardEvent<HTMLButtonElement>) => unknown) | undefined;
24
+ onMouseDown?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
25
+ onPointerDown?: ((event: import("react").MouseEvent<HTMLButtonElement, MouseEvent>) => unknown) | undefined;
26
+ children?: import("react").ReactNode;
41
27
  className?: string | undefined;
42
28
  } & import("react").RefAttributes<HTMLButtonElement>>;
@@ -10,6 +10,4 @@ export declare const DrawerCaption: import("react").ForwardRefExoticComponent<im
10
10
  } & {
11
11
  /** */
12
12
  children: ReactNode;
13
- /** */
14
- className?: string | undefined;
15
13
  } & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,5 +1,8 @@
1
1
  import { ReactNode } from "react";
2
2
  /**
3
+ * @deprecated
4
+ * これまでフッターに配置していたボタン等は、ヘッダーの右側に置くようにしてください。
5
+ *
3
6
  * @group React コンポーネント
4
7
  * @category React コンポーネント
5
8
  */
@@ -10,6 +13,4 @@ export declare const DrawerFooter: import("react").ForwardRefExoticComponent<imp
10
13
  } & {
11
14
  /** */
12
15
  children: ReactNode;
13
- /** */
14
- className?: string | undefined;
15
16
  } & import("react").RefAttributes<HTMLDivElement>>;
@@ -10,6 +10,4 @@ export declare const DrawerHeader: import("react").ForwardRefExoticComponent<imp
10
10
  } & {
11
11
  /** */
12
12
  children: ReactNode;
13
- /** */
14
- className?: string | undefined;
15
13
  } & import("react").RefAttributes<HTMLDivElement>>;
@@ -0,0 +1,13 @@
1
+ import { ReactNode } from "react";
2
+ /**
3
+ * @group React コンポーネント
4
+ * @category React コンポーネント
5
+ */
6
+ export declare const DrawerHeaderLeft: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
7
+ className?: string | undefined;
8
+ id?: string | undefined;
9
+ style?: import("react").CSSProperties | undefined;
10
+ } & {
11
+ /** */
12
+ children: ReactNode;
13
+ } & import("react").RefAttributes<HTMLDivElement>>;
@@ -0,0 +1,13 @@
1
+ import { ReactNode } from "react";
2
+ /**
3
+ * @group React コンポーネント
4
+ * @category React コンポーネント
5
+ */
6
+ export declare const DrawerHeaderRight: import("react").ForwardRefExoticComponent<import("../../../modules/data").DataProps<string> & {
7
+ className?: string | undefined;
8
+ id?: string | undefined;
9
+ style?: import("react").CSSProperties | undefined;
10
+ } & {
11
+ /** */
12
+ children: ReactNode;
13
+ } & import("react").RefAttributes<HTMLDivElement>>;
@@ -15,6 +15,4 @@ export declare const DrawerTitle: import("react").ForwardRefExoticComponent<impo
15
15
  as?: "div" | "h2" | "h3" | "h4" | "h5" | "h6" | undefined;
16
16
  /** */
17
17
  children: ReactNode;
18
- /** */
19
- className?: string | undefined;
20
18
  } & import("react").RefAttributes<HTMLHeadingElement>>;