@narmi/design_system 6.17.4 → 6.17.6
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.
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/tokens/css/rgbColors.css +1 -1
- package/dist/tokens/css/rgbColors.scss +1 -1
- package/dist/tokens/css/tokens.css +1 -1
- package/dist/tokens/css/tokens.scss +1 -1
- package/dist/tokens/js/colors.esm.js +1 -1
- package/dist/tokens/js/colors.js +1 -1
- package/dist/tokens/js/manifest.esm.js +1 -1
- package/dist/tokens/js/manifest.js +1 -1
- package/dist/tokens/js/reactNativeWeb.js +1 -1
- package/dist/types/Error/index.d.ts +5 -1
- package/dist/types/Error/index.d.ts.map +1 -1
- package/dist/types/FormSection/index.d.ts +5 -4
- package/dist/types/FormSection/index.d.ts.map +1 -1
- package/dist/types/IconButton/index.d.ts +72 -0
- package/dist/types/IconButton/index.d.ts.map +1 -0
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/util/AsElement.d.ts +44 -0
- package/dist/types/util/AsElement.d.ts.map +1 -0
- package/package.json +1 -1
package/dist/tokens/js/colors.js
CHANGED
|
@@ -2,7 +2,11 @@ import { default as React } from 'react';
|
|
|
2
2
|
import { default as PropTypes } from 'prop-types';
|
|
3
3
|
type MarginTop = "xxs" | "xs" | "s" | "m" | "l" | "xl" | "xxl" | "none";
|
|
4
4
|
interface ErrorProps {
|
|
5
|
-
|
|
5
|
+
/**
|
|
6
|
+
* Error message(s) to display. Falsy values (including `null`) render
|
|
7
|
+
* nothing, which lets callers pass nullable state directly.
|
|
8
|
+
*/
|
|
9
|
+
error?: string | string[] | null;
|
|
6
10
|
marginTop?: MarginTop;
|
|
7
11
|
}
|
|
8
12
|
declare const Error: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Error/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,KAAK,SAAS,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC;AAqBxE,UAAU,UAAU;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Error/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,KAAK,SAAS,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC;AAqBxE,UAAU,UAAU;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,QAAA,MAAM,KAAK;2BAAkC,UAAU;;;;;CAgBtD,CAAC;AASF,eAAe,KAAK,CAAC"}
|
|
@@ -2,8 +2,9 @@ import { default as React } from 'react';
|
|
|
2
2
|
import { default as PropTypes } from 'prop-types';
|
|
3
3
|
interface FormSectionProps {
|
|
4
4
|
/** Title of form section */
|
|
5
|
-
title
|
|
6
|
-
|
|
5
|
+
title?: string;
|
|
6
|
+
/** Optional content rendered below the section heading */
|
|
7
|
+
children?: React.ReactNode;
|
|
7
8
|
}
|
|
8
9
|
/**
|
|
9
10
|
* A sectioning element for forms that renders a label and line above the section
|
|
@@ -12,8 +13,8 @@ declare const FormSection: {
|
|
|
12
13
|
({ title, children }: FormSectionProps): React.JSX.Element;
|
|
13
14
|
propTypes: {
|
|
14
15
|
/** Title of form section */
|
|
15
|
-
title: PropTypes.
|
|
16
|
-
children: PropTypes.
|
|
16
|
+
title: PropTypes.Requireable<string>;
|
|
17
|
+
children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
|
|
17
18
|
};
|
|
18
19
|
};
|
|
19
20
|
export default FormSection;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/FormSection/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAGnC,UAAU,gBAAgB;IACxB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/FormSection/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAGnC,UAAU,gBAAgB;IACxB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,QAAA,MAAM,WAAW;0BAAyB,gBAAgB;;QAkCxD,4BAA4B;;;;CAH7B,CAAC;AAQF,eAAe,WAAW,CAAC"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { default as PropTypes } from 'prop-types';
|
|
3
|
+
import { VALID_ICON_NAMES } from '../icons/iconNames';
|
|
4
|
+
import { IconName } from '../types/Icon.types';
|
|
5
|
+
export { VALID_ICON_NAMES };
|
|
6
|
+
export type IconButtonKind = "action" | "plain" | "themed";
|
|
7
|
+
export interface IconButtonProps {
|
|
8
|
+
/** Name of Narmi icon */
|
|
9
|
+
name: IconName;
|
|
10
|
+
/** Renders the icon button label */
|
|
11
|
+
label?: string;
|
|
12
|
+
/** disables the icon button when set to `true` */
|
|
13
|
+
disabled?: boolean;
|
|
14
|
+
/** style of icon button to render */
|
|
15
|
+
kind?: IconButtonKind;
|
|
16
|
+
/** type attribute for underlying HTML button element */
|
|
17
|
+
type?: string;
|
|
18
|
+
/** Optional text size of the icon in the icon button defaults different for different kinds (plain/action)*/
|
|
19
|
+
textSize?: "xs" | "s" | "m" | "l";
|
|
20
|
+
/** Click callback, with event object passed as argument */
|
|
21
|
+
onClick?: (event: React.MouseEvent) => void;
|
|
22
|
+
/** Optional value for `data-testid` attribute */
|
|
23
|
+
testId?: string;
|
|
24
|
+
/** className for adding classNames to the icon button */
|
|
25
|
+
className?: string;
|
|
26
|
+
/**
|
|
27
|
+
* The html element to render as the root node of `Button`.
|
|
28
|
+
*
|
|
29
|
+
* When rendering as an "a" you **MUST** pass an `href` attribute
|
|
30
|
+
* for the anchor to be valid.
|
|
31
|
+
*/
|
|
32
|
+
as?: "a" | "button";
|
|
33
|
+
[x: string]: unknown;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Narmi style Icon Button.
|
|
37
|
+
*
|
|
38
|
+
* Icon Button renders a button with a central Narmi icon
|
|
39
|
+
*
|
|
40
|
+
*/
|
|
41
|
+
declare const IconButton: {
|
|
42
|
+
({ disabled, kind, textSize, testId, label, name, onClick, type, as, ...otherProps }: IconButtonProps): React.JSX.Element;
|
|
43
|
+
propTypes: {
|
|
44
|
+
/** Name of Narmi icon */
|
|
45
|
+
name: PropTypes.Validator<string>;
|
|
46
|
+
/** Renders the icon button label */
|
|
47
|
+
label: PropTypes.Requireable<string>;
|
|
48
|
+
/** disables the icon button when set to `true` */
|
|
49
|
+
disabled: PropTypes.Requireable<boolean>;
|
|
50
|
+
/** style of icon button to render */
|
|
51
|
+
kind: PropTypes.Requireable<string>;
|
|
52
|
+
/** type attribute for underlying HTML button element */
|
|
53
|
+
type: PropTypes.Requireable<string>;
|
|
54
|
+
/** Optional text size of the icon in the icon button defaults different for different kinds (plain/action)*/
|
|
55
|
+
textSize: PropTypes.Requireable<string>;
|
|
56
|
+
/** Click callback, with event object passed as argument */
|
|
57
|
+
onClick: PropTypes.Requireable<(...args: any[]) => any>;
|
|
58
|
+
/** Optional value for `data-testid` attribute */
|
|
59
|
+
testId: PropTypes.Requireable<string>;
|
|
60
|
+
/** className for adding classNames to the icon button */
|
|
61
|
+
className: PropTypes.Requireable<string>;
|
|
62
|
+
/**
|
|
63
|
+
* The html element to render as the root node of `Button`.
|
|
64
|
+
*
|
|
65
|
+
* When rendering as an "a" you **MUST** pass an `href` attribute
|
|
66
|
+
* for the anchor to be valid.
|
|
67
|
+
*/
|
|
68
|
+
as: PropTypes.Requireable<string>;
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
export default IconButton;
|
|
72
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/IconButton/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,gBAAgB,EAAE,CAAC;AAE5B,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE3D,MAAM,WAAW,eAAe;IAC9B,yBAAyB;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAClC,2DAA2D;IAC3D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;IAC5C,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,EAAE,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC;IACpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,QAAA,MAAM,UAAU;0FAWb,eAAe;;QA0BhB,yBAAyB;;QAEzB,oCAAoC;;QAEpC,kDAAkD;;QAElD,qCAAqC;;QAErC,wDAAwD;;QAExD,6GAA6G;;QAE7G,2DAA2D;;QAE3D,iDAAiD;;QAEjD,0DAA0D;;QAE1D;;;;;WAKG;;;CA1BJ,CAAC;AA8BF,eAAe,UAAU,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ import { default as ContextMenu } from './ContextMenu';
|
|
|
12
12
|
import { default as Count } from './Count';
|
|
13
13
|
import { default as Dialog } from './Dialog';
|
|
14
14
|
import { default as DisabledShim } from './DisabledShim';
|
|
15
|
+
import { default as Error } from './Error';
|
|
15
16
|
import { default as DropdownTrigger } from './DropdownTrigger';
|
|
16
17
|
import { default as Field } from './Field';
|
|
17
18
|
import { default as FormSection } from './FormSection';
|
|
@@ -47,7 +48,6 @@ declare const CollapsibleCard: any;
|
|
|
47
48
|
declare const Combobox: any;
|
|
48
49
|
declare const DateInput: any;
|
|
49
50
|
declare const Drawer: any;
|
|
50
|
-
declare const Error: any;
|
|
51
51
|
declare const FieldToken: any;
|
|
52
52
|
declare const IconButton: any;
|
|
53
53
|
declare const Input: any;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,4BAA4B,MAAM,sCAAsC,CAAC;AAChF,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,UAAU,MAAM,yBAAyB,CAAC;AACjD,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD;;GAEG;AACH,OAAO,CAAC,MAAM,eAAe,KAAA,CAAC;AAC9B,OAAO,CAAC,MAAM,QAAQ,KAAA,CAAC;AACvB,OAAO,CAAC,MAAM,SAAS,KAAA,CAAC;AACxB,OAAO,CAAC,MAAM,MAAM,KAAA,CAAC;AACrB,OAAO,CAAC,MAAM,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AACpD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,4BAA4B,MAAM,sCAAsC,CAAC;AAChF,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,UAAU,MAAM,yBAAyB,CAAC;AACjD,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,YAAY,MAAM,2BAA2B,CAAC;AAErD;;GAEG;AACH,OAAO,CAAC,MAAM,eAAe,KAAA,CAAC;AAC9B,OAAO,CAAC,MAAM,QAAQ,KAAA,CAAC;AACvB,OAAO,CAAC,MAAM,SAAS,KAAA,CAAC;AACxB,OAAO,CAAC,MAAM,MAAM,KAAA,CAAC;AACrB,OAAO,CAAC,MAAM,UAAU,KAAA,CAAC;AACzB,OAAO,CAAC,MAAM,UAAU,KAAA,CAAC;AACzB,OAAO,CAAC,MAAM,KAAK,KAAA,CAAC;AACpB,OAAO,CAAC,MAAM,WAAW,KAAA,CAAC;AAC1B,OAAO,CAAC,MAAM,UAAU,KAAA,CAAC;AACzB,OAAO,CAAC,MAAM,WAAW,KAAA,CAAC;AAC1B,OAAO,CAAC,MAAM,OAAO,KAAA,CAAC;AACtB,OAAO,CAAC,MAAM,cAAc,KAAA,CAAC;AAC7B,OAAO,CAAC,MAAM,MAAM,KAAA,CAAC;AACrB,OAAO,CAAC,MAAM,OAAO,KAAA,CAAC;AACtB,OAAO,CAAC,MAAM,GAAG,KAAA,CAAC;AAClB,OAAO,CAAC,MAAM,SAAS,KAAA,CAAC;AACxB,OAAO,CAAC,MAAM,aAAa,KAAA,CAAC;AAC5B,OAAO,CAAC,MAAM,MAAM,KAAA,CAAC;AACrB,OAAO,CAAC,MAAM,UAAU,KAAA,CAAC;AAEzB,cAAc,oBAAoB,CAAC;AACnC,OAAO,EACL,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,MAAM,EACN,MAAM,EACN,QAAQ,EACR,IAAI,EACJ,WAAW,EACX,WAAW,EACX,KAAK,EACL,YAAY,EACZ,KAAK,EACL,YAAY,EACZ,GAAG,EACH,aAAa,EACb,MAAM,EACN,QAAQ,EACR,KAAK,EACL,cAAc,EACd,eAAe,EACf,QAAQ,EACR,SAAS,EACT,MAAM,EACN,MAAM,EACN,eAAe,EACf,KAAK,EACL,KAAK,EACL,UAAU,EACV,WAAW,EACX,UAAU,EACV,KAAK,EACL,WAAW,EACX,eAAe,EACf,UAAU,EACV,WAAW,EACX,UAAU,EACV,WAAW,EACX,OAAO,EACP,cAAc,EACd,MAAM,EACN,OAAO,EACP,OAAO,EACP,WAAW,EACX,KAAK,EACL,iBAAiB,EACjB,cAAc,EACd,UAAU,EACV,WAAW,EACX,IAAI,EACJ,GAAG,EACH,SAAS,EACT,aAAa,EACb,MAAM,EACN,UAAU,EACV,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,4BAA4B,EAC5B,YAAY,EACZ,UAAU,GACX,CAAC"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { default as React } from 'react';
|
|
2
|
+
import { default as PropTypes } from 'prop-types';
|
|
3
|
+
/**
|
|
4
|
+
* Returns the href if it uses a safe protocol, or undefined if it
|
|
5
|
+
* uses a potentially dangerous scheme (javascript:, data:, etc).
|
|
6
|
+
*
|
|
7
|
+
* Accepts `unknown` rather than `string` on purpose: this is a security
|
|
8
|
+
* guard, and it must keep rejecting non-string input that reaches it from
|
|
9
|
+
* untyped call sites at runtime.
|
|
10
|
+
*/
|
|
11
|
+
export declare const getSafeHref: (href?: unknown) => string | null | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* This is not a complete list of HTML elements;
|
|
14
|
+
* only the elements we want to support in `as` props.
|
|
15
|
+
*/
|
|
16
|
+
export declare const VALID_ELEMENTS: string[];
|
|
17
|
+
export interface AsElementProps {
|
|
18
|
+
/** element to render */
|
|
19
|
+
elementType?: React.ElementType;
|
|
20
|
+
children?: React.ReactNode;
|
|
21
|
+
/**
|
|
22
|
+
* Any additional props are spread onto the rendered element.
|
|
23
|
+
* `AsElement` is a passthrough, so this is intentionally open-ended.
|
|
24
|
+
*/
|
|
25
|
+
[key: string]: unknown;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Utility to conditionally render different HTML elements
|
|
29
|
+
* in our components. Useful for exposing `as` props:
|
|
30
|
+
*
|
|
31
|
+
* `<Row as="ul"><Row.Item as="li" /></Row>
|
|
32
|
+
*
|
|
33
|
+
* @usage <AsElement elementName="ul" otherProp="this gets passed through">
|
|
34
|
+
*/
|
|
35
|
+
declare const AsElement: {
|
|
36
|
+
({ elementType, children, ...rest }: AsElementProps): React.JSX.Element;
|
|
37
|
+
propTypes: {
|
|
38
|
+
/** element to render */
|
|
39
|
+
elementType: PropTypes.Validator<NonNullable<NonNullable<string | ((...args: any[]) => any)>>>;
|
|
40
|
+
children: PropTypes.Requireable<NonNullable<PropTypes.ReactNodeLike>>;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
export default AsElement;
|
|
44
|
+
//# sourceMappingURL=AsElement.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AsElement.d.ts","sourceRoot":"","sources":["../../../src/util/AsElement.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,SAAS,MAAM,YAAY,CAAC;AAInC;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,MAAM,GAAG,IAAI,GAAG,SAU5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,UAkB1B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC;IAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;OAGG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,QAAA,MAAM,SAAS;yCAIZ,cAAc;;QA6Bf,yBAAyB;;;;CAH1B,CAAC;AAcF,eAAe,SAAS,CAAC"}
|