@instructure/ui-form-field 9.11.0 → 9.11.1
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/CHANGELOG.md +11 -0
- package/es/FormField/index.js +5 -1
- package/es/FormFieldGroup/__new-tests__/FormFieldGroup.test.js +4 -4
- package/es/FormFieldGroup/index.js +18 -4
- package/es/FormFieldLabel/index.js +6 -6
- package/es/FormFieldLayout/__new-tests__/FormFieldLayout.test.js +10 -8
- package/es/FormFieldLayout/index.js +79 -58
- package/es/FormFieldLayout/props.js +1 -6
- package/es/FormFieldLayout/styles.js +105 -9
- package/es/FormFieldLayout/theme.js +56 -0
- package/es/FormFieldMessages/props.js +3 -2
- package/es/FormFieldMessages/styles.js +5 -3
- package/es/FormPropTypes.js +6 -0
- package/lib/FormField/index.js +5 -1
- package/lib/FormFieldGroup/__new-tests__/FormFieldGroup.test.js +4 -4
- package/lib/FormFieldGroup/index.js +18 -4
- package/lib/FormFieldLabel/index.js +6 -5
- package/lib/FormFieldLayout/__new-tests__/FormFieldLayout.test.js +9 -7
- package/lib/FormFieldLayout/index.js +77 -58
- package/lib/FormFieldLayout/props.js +1 -6
- package/lib/FormFieldLayout/styles.js +105 -9
- package/lib/FormFieldLayout/theme.js +62 -0
- package/lib/FormFieldMessages/props.js +3 -2
- package/lib/FormFieldMessages/styles.js +5 -3
- package/lib/FormPropTypes.js +6 -0
- package/package.json +15 -15
- package/src/FormField/README.md +31 -3
- package/src/FormField/index.tsx +3 -0
- package/src/FormFieldGroup/__new-tests__/FormFieldGroup.test.tsx +4 -6
- package/src/FormFieldGroup/index.tsx +41 -6
- package/src/FormFieldLabel/index.tsx +8 -3
- package/src/FormFieldLayout/__new-tests__/FormFieldLayout.test.tsx +6 -8
- package/src/FormFieldLayout/index.tsx +83 -100
- package/src/FormFieldLayout/props.ts +30 -7
- package/src/FormFieldLayout/styles.ts +124 -12
- package/src/FormFieldLayout/theme.ts +59 -0
- package/src/FormFieldMessages/props.ts +8 -2
- package/src/FormFieldMessages/styles.ts +5 -4
- package/src/FormPropTypes.ts +4 -0
- package/tsconfig.build.tsbuildinfo +1 -1
- package/types/FormField/index.d.ts.map +1 -1
- package/types/FormFieldGroup/index.d.ts +1 -0
- package/types/FormFieldGroup/index.d.ts.map +1 -1
- package/types/FormFieldLabel/index.d.ts +2 -2
- package/types/FormFieldLabel/index.d.ts.map +1 -1
- package/types/FormFieldLayout/index.d.ts +8 -7
- package/types/FormFieldLayout/index.d.ts.map +1 -1
- package/types/FormFieldLayout/props.d.ts +27 -3
- package/types/FormFieldLayout/props.d.ts.map +1 -1
- package/types/FormFieldLayout/styles.d.ts +4 -3
- package/types/FormFieldLayout/styles.d.ts.map +1 -1
- package/types/FormFieldLayout/theme.d.ts +10 -0
- package/types/FormFieldLayout/theme.d.ts.map +1 -0
- package/types/FormFieldMessages/index.d.ts +8 -2
- package/types/FormFieldMessages/index.d.ts.map +1 -1
- package/types/FormFieldMessages/props.d.ts +5 -0
- package/types/FormFieldMessages/props.d.ts.map +1 -1
- package/types/FormFieldMessages/styles.d.ts +2 -3
- package/types/FormFieldMessages/styles.d.ts.map +1 -1
- package/types/FormPropTypes.d.ts +3 -0
- package/types/FormPropTypes.d.ts.map +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormField/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS,gGAAY;IAC5B,MAAM,CAAC,YAAY,yDAAe;IAClC,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,MAAM;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormField/index.tsx"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C;;;;GAIG;AACH,cAAM,SAAU,SAAQ,SAAS,CAAC,cAAc,CAAC;IAC/C,MAAM,CAAC,QAAQ,CAAC,WAAW,eAAc;IAEzC,MAAM,CAAC,SAAS,gGAAY;IAC5B,MAAM,CAAC,YAAY,yDAAe;IAClC,MAAM,CAAC,YAAY;;;;;MAKlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,MAAM;CAgBP;AAED,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldGroup/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldGroup/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAA0C,MAAM,OAAO,CAAA;AAIzE,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAE5E;;;;GAIG;AACH,cACM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,oBAAmB;IAE9C,MAAM,CAAC,SAAS;qBAXD,MAAO,SAAS;;;;;mBAe7B,MAAE,SAAS;;;;;;;OAJe;IAC5B,MAAM,CAAC,YAAY;2BAZG,SAAS;;;;;yBAe3B,SAAS;;;;;;;SAHqB;IAClC,MAAM,CAAC,YAAY;;;;;;;MAOlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,mBAAmB,IAAI,wBAAwB,CAQlD;IAED,IAAI,OAAO,YAOV;IAED,aAAa;IAiBb,cAAc;IAgBd,YAAY;IAUZ,MAAM;CA+CP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
|
|
@@ -7,8 +7,7 @@ import type { FormFieldLabelProps } from './props';
|
|
|
7
7
|
parent: FormField
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
This is a helper component that is used by most of the custom form
|
|
11
|
-
components. In most cases it shouldn't be used directly.
|
|
10
|
+
This is a helper component that is used by most of the custom form components. In most cases it shouldn't be used directly.
|
|
12
11
|
|
|
13
12
|
```js
|
|
14
13
|
---
|
|
@@ -17,6 +16,7 @@ type: example
|
|
|
17
16
|
<FormFieldLabel>Hello</FormFieldLabel>
|
|
18
17
|
```
|
|
19
18
|
|
|
19
|
+
@deprecated This is an internal component that will be removed in the future
|
|
20
20
|
**/
|
|
21
21
|
declare class FormFieldLabel extends Component<FormFieldLabelProps> {
|
|
22
22
|
static readonly componentId = "FormFieldLabel";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldLabel/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldLabel/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAMrD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;;;;;;;;;GAeG;AACH,cAEM,cAAe,SAAQ,SAAS,CAAC,mBAAmB,CAAC;IACzD,MAAM,CAAC,QAAQ,CAAC,WAAW,oBAAmB;IAE9C,MAAM,CAAC,SAAS;kBAxBb,MAAO,SAAS;;OAwBS;IAC5B,MAAM,CAAC,YAAY;wBAzBT,SAAS;;SAyBe;IAClC,MAAM,CAAC,YAAY;;MAET;IAEV,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,MAAM;CAeP;AAED,eAAe,cAAc,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,CAAA"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import { Component } from 'react';
|
|
3
3
|
import { jsx } from '@instructure/emotion';
|
|
4
|
+
import { FormFieldStyleProps } from './props';
|
|
4
5
|
import type { FormFieldLayoutProps } from './props';
|
|
5
6
|
/**
|
|
6
7
|
---
|
|
@@ -19,17 +20,17 @@ declare class FormFieldLayout extends Component<FormFieldLayoutProps> {
|
|
|
19
20
|
};
|
|
20
21
|
constructor(props: FormFieldLayoutProps);
|
|
21
22
|
private _messagesId;
|
|
23
|
+
private _labelId;
|
|
22
24
|
ref: Element | null;
|
|
23
25
|
handleRef: (el: Element | null) => void;
|
|
24
26
|
componentDidMount(): void;
|
|
25
27
|
componentDidUpdate(): void;
|
|
26
|
-
|
|
27
|
-
get
|
|
28
|
-
get
|
|
29
|
-
get
|
|
30
|
-
handleInputContainerRef: (node:
|
|
31
|
-
renderLabel():
|
|
32
|
-
renderLegend(): jsx.JSX.Element;
|
|
28
|
+
makeStyleProps: () => FormFieldStyleProps;
|
|
29
|
+
get hasVisibleLabel(): boolean;
|
|
30
|
+
get hasMessages(): boolean;
|
|
31
|
+
get elementType(): import("react").ComponentClass<any, any> | import("react").FunctionComponent<Readonly<FormFieldLayoutProps>> | import("react").ComponentClass<Readonly<FormFieldLayoutProps>, any> | NonNullable<import("@instructure/shared-types").AsElementType | undefined>;
|
|
32
|
+
handleInputContainerRef: (node: HTMLElement | null) => void;
|
|
33
|
+
renderLabel(): jsx.JSX.Element | null;
|
|
33
34
|
renderVisibleMessages(): jsx.JSX.Element | null;
|
|
34
35
|
render(): jsx.JSX.Element;
|
|
35
36
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAQjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAGrD,OAAO,EAA2B,mBAAmB,EAAE,MAAM,SAAS,CAAA;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAGnD;;;;GAIG;AACH,cAEM,eAAgB,SAAQ,SAAS,CAAC,oBAAoB,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,WAAW,qBAAoB;IAE/C,MAAM,CAAC,SAAS,sGAAY;IAC5B,MAAM,CAAC,YAAY,+DAAe;IAClC,MAAM,CAAC,YAAY;;;;;MAKT;gBAEE,KAAK,EAAE,oBAAoB;IAMvC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAQ;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAQ9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,cAAc,QAAO,mBAAmB,CAUvC;IAED,IAAI,eAAe,YAElB;IAED,IAAI,WAAW,YAed;IAED,IAAI,WAAW,oQAEd;IAED,uBAAuB,SAAU,WAAW,GAAG,IAAI,UAIlD;IAED,WAAW;IAiCX,qBAAqB;IAUrB,MAAM;CAiCP;AAED,eAAe,eAAe,CAAA;AAC9B,OAAO,EAAE,eAAe,EAAE,CAAA"}
|
|
@@ -24,12 +24,31 @@ type FormFieldLayoutOwnProps = {
|
|
|
24
24
|
*/
|
|
25
25
|
messagesId?: string;
|
|
26
26
|
children?: React.ReactNode;
|
|
27
|
+
/**
|
|
28
|
+
* If `true` use an inline layout -- content will flow on the left/right side
|
|
29
|
+
* of this component
|
|
30
|
+
*/
|
|
27
31
|
inline?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* In `stacked` mode the container is below the label, in `inline` mode the
|
|
34
|
+
* container is to the right/left (depending on text direction)
|
|
35
|
+
*/
|
|
28
36
|
layout?: 'stacked' | 'inline';
|
|
37
|
+
/**
|
|
38
|
+
* The horizontal alignment of the label. Only works in `inline` layout
|
|
39
|
+
*/
|
|
29
40
|
labelAlign?: 'start' | 'end';
|
|
41
|
+
/**
|
|
42
|
+
* The vertical alignment of the label and the controls.
|
|
43
|
+
* "top" by default
|
|
44
|
+
*/
|
|
30
45
|
vAlign?: 'top' | 'middle' | 'bottom';
|
|
31
46
|
width?: string;
|
|
32
|
-
|
|
47
|
+
/**
|
|
48
|
+
* Provides a reference to the container that holds the input element
|
|
49
|
+
* @param element The element that holds the input control as its children
|
|
50
|
+
*/
|
|
51
|
+
inputContainerRef?: (element: HTMLElement | null) => void;
|
|
33
52
|
/**
|
|
34
53
|
* provides a reference to the underlying html root element
|
|
35
54
|
*/
|
|
@@ -39,9 +58,14 @@ type FormFieldLayoutOwnProps = {
|
|
|
39
58
|
type PropKeys = keyof FormFieldLayoutOwnProps;
|
|
40
59
|
type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
41
60
|
type FormFieldLayoutProps = FormFieldLayoutOwnProps & WithStyleProps<null, FormFieldLayoutStyle> & OtherHTMLAttributes<FormFieldLayoutOwnProps> & WithDeterministicIdProps;
|
|
42
|
-
type FormFieldLayoutStyle = ComponentStyle<'formFieldLayout' | '
|
|
61
|
+
type FormFieldLayoutStyle = ComponentStyle<'formFieldLayout' | 'formFieldLabel' | 'formFieldChildren'>;
|
|
43
62
|
declare const propTypes: PropValidators<PropKeys>;
|
|
44
63
|
declare const allowedProps: AllowedPropKeys;
|
|
45
|
-
|
|
64
|
+
type FormFieldStyleProps = {
|
|
65
|
+
hasMessages: boolean;
|
|
66
|
+
hasVisibleLabel: boolean;
|
|
67
|
+
hasNewErrorMsgAndIsGroup: boolean;
|
|
68
|
+
};
|
|
69
|
+
export type { FormFieldStyleProps, FormFieldLayoutProps, FormFieldLayoutStyle, FormFieldLayoutOwnProps };
|
|
46
70
|
export { propTypes, allowedProps };
|
|
47
71
|
//# sourceMappingURL=props.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC7B,UAAU,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;IAC5B,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,cAAc,EACf,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE3E,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC,SAAS,CAAA;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,EAAE,CAAC,EAAE,aAAa,CAAA;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,KAAK,IAAI,CAAA;IACzD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,uBAAuB,CAAA;AAE7C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,oBAAoB,GAAG,uBAAuB,GACjD,cAAc,CAAC,IAAI,EAAE,oBAAoB,CAAC,GAC1C,mBAAmB,CAAC,uBAAuB,CAAC,GAC5C,wBAAwB,CAAA;AAE1B,KAAK,oBAAoB,GAAG,cAAc,CACxC,iBAAiB,GAAG,gBAAgB,GAAG,mBAAmB,CAC3D,CAAA;AAED,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAevC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAcnB,CAAA;AAED,KAAK,mBAAmB,GAAG;IACzB,WAAW,EAAE,OAAO,CAAA;IACpB,eAAe,EAAE,OAAO,CAAA;IACxB,wBAAwB,EAAE,OAAO,CAAA;CAClC,CAAA;AAED,YAAY,EACV,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACxB,CAAA;AACD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type { FormFieldLayoutProps, FormFieldLayoutStyle } from './props';
|
|
1
|
+
import type { FormFieldLayoutProps, FormFieldLayoutStyle, FormFieldStyleProps } from './props';
|
|
2
|
+
import type { FormFieldLayoutTheme } from '@instructure/shared-types';
|
|
2
3
|
/**
|
|
3
4
|
* ---
|
|
4
5
|
* private: true
|
|
@@ -6,9 +7,9 @@ import type { FormFieldLayoutProps, FormFieldLayoutStyle } from './props';
|
|
|
6
7
|
* Generates the style object from the theme and provided additional information
|
|
7
8
|
* @param {Object} componentTheme The theme variable object.
|
|
8
9
|
* @param {Object} props the props of the component, the style is applied to
|
|
9
|
-
* @param {Object}
|
|
10
|
+
* @param {Object} styleProps
|
|
10
11
|
* @return {Object} The final style object, which will be used in the component
|
|
11
12
|
*/
|
|
12
|
-
declare const generateStyle: (
|
|
13
|
+
declare const generateStyle: (componentTheme: FormFieldLayoutTheme, props: FormFieldLayoutProps, styleProps: FormFieldStyleProps) => FormFieldLayoutStyle;
|
|
13
14
|
export default generateStyle;
|
|
14
15
|
//# sourceMappingURL=styles.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAgCrE;;;;;;;;;GASG;AACH,QAAA,MAAM,aAAa,mBACD,oBAAoB,SAC7B,oBAAoB,cACf,mBAAmB,KAC9B,oBAuGF,CAAA;AAED,eAAe,aAAa,CAAA"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Theme } from '@instructure/ui-themes';
|
|
2
|
+
import { FormFieldLayoutTheme } from '@instructure/shared-types';
|
|
3
|
+
/**
|
|
4
|
+
* Generates the theme object for the component from the theme and provided additional information
|
|
5
|
+
* @param {Object} theme The actual theme object.
|
|
6
|
+
* @return {Object} The final theme object with the overrides and component variables
|
|
7
|
+
*/
|
|
8
|
+
declare const generateComponentTheme: (theme: Theme) => FormFieldLayoutTheme;
|
|
9
|
+
export default generateComponentTheme;
|
|
10
|
+
//# sourceMappingURL=theme.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/FormFieldLayout/theme.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,KAAK,EAAsB,MAAM,wBAAwB,CAAA;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAEhE;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,UAAW,KAAK,KAAG,oBAwB9C,CAAA;AAED,eAAe,sBAAsB,CAAA"}
|
|
@@ -22,8 +22,14 @@ type: example
|
|
|
22
22
|
**/
|
|
23
23
|
declare class FormFieldMessages extends Component<FormFieldMessagesProps> {
|
|
24
24
|
static readonly componentId = "FormFieldMessages";
|
|
25
|
-
static propTypes: import("@instructure/shared-types").PropValidators<
|
|
26
|
-
|
|
25
|
+
static propTypes: import("@instructure/shared-types").PropValidators<keyof {
|
|
26
|
+
messages?: import("..").FormMessage[];
|
|
27
|
+
gridArea?: string;
|
|
28
|
+
}>;
|
|
29
|
+
static allowedProps: readonly (keyof {
|
|
30
|
+
messages?: import("..").FormMessage[];
|
|
31
|
+
gridArea?: string;
|
|
32
|
+
})[];
|
|
27
33
|
static defaultProps: {};
|
|
28
34
|
ref: Element | null;
|
|
29
35
|
handleRef: (el: Element | null) => void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,cACM,iBAAkB,SAAQ,SAAS,CAAC,sBAAsB,CAAC;IAC/D,MAAM,CAAC,QAAQ,CAAC,WAAW,uBAAsB;IAEjD,MAAM,CAAC,SAAS
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/index.tsx"],"names":[],"mappings":"AAwBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAQrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,cACM,iBAAkB,SAAQ,SAAS,CAAC,sBAAsB,CAAC;IAC/D,MAAM,CAAC,QAAQ,CAAC,WAAW,uBAAsB;IAEjD,MAAM,CAAC,SAAS;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;SAAe;IAClC,MAAM,CAAC,YAAY,KAAK;IAExB,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,SAAS,OAAQ,OAAO,GAAG,IAAI,UAE9B;IAED,iBAAiB;IAIjB,kBAAkB;IAIlB,MAAM;CAmBP;AAED,eAAe,iBAAiB,CAAA;AAChC,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
|
|
@@ -9,6 +9,11 @@ type FormFieldMessagesOwnProps = {
|
|
|
9
9
|
* }`
|
|
10
10
|
*/
|
|
11
11
|
messages?: FormMessage[];
|
|
12
|
+
/**
|
|
13
|
+
* Specifies the size and location if inside a CSS grid, see
|
|
14
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area
|
|
15
|
+
*/
|
|
16
|
+
gridArea?: string;
|
|
12
17
|
};
|
|
13
18
|
type PropKeys = keyof FormFieldMessagesOwnProps;
|
|
14
19
|
type AllowedPropKeys = Readonly<Array<PropKeys>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,KAAK,yBAAyB,GAAG;IAC/B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/props.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EACV,cAAc,EACd,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,KAAK,yBAAyB,GAAG;IAC/B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,KAAK,QAAQ,GAAG,MAAM,yBAAyB,CAAA;AAE/C,KAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,KAAK,sBAAsB,GAAG,yBAAyB,GACrD,cAAc,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,GAC9D,mBAAmB,CAAC,yBAAyB,CAAC,CAAA;AAEhD,KAAK,sBAAsB,GAAG,cAAc,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAAA;AAE7E,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAGvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAA0C,CAAA;AAE9D,YAAY,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,CAAA;AAC9D,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { FormFieldMessagesTheme } from '@instructure/shared-types';
|
|
2
|
-
import type { FormFieldMessagesStyle } from './props';
|
|
2
|
+
import type { FormFieldMessagesProps, FormFieldMessagesStyle } from './props';
|
|
3
3
|
/**
|
|
4
4
|
* ---
|
|
5
5
|
* private: true
|
|
@@ -7,9 +7,8 @@ import type { FormFieldMessagesStyle } from './props';
|
|
|
7
7
|
* Generates the style object from the theme and provided additional information
|
|
8
8
|
* @param {Object} componentTheme The theme variable object.
|
|
9
9
|
* @param {Object} props the props of the component, the style is applied to
|
|
10
|
-
* @param {Object} state the state of the component, the style is applied to
|
|
11
10
|
* @return {Object} The final style object, which will be used in the component
|
|
12
11
|
*/
|
|
13
|
-
declare const generateStyle: (componentTheme: FormFieldMessagesTheme) => FormFieldMessagesStyle;
|
|
12
|
+
declare const generateStyle: (componentTheme: FormFieldMessagesTheme, props: FormFieldMessagesProps) => FormFieldMessagesStyle;
|
|
14
13
|
export default generateStyle;
|
|
15
14
|
//# sourceMappingURL=styles.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/FormFieldMessages/styles.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAE7E;;;;;;;;GAQG;AACH,QAAA,MAAM,aAAa,mBACD,sBAAsB,SAC/B,sBAAsB,KAC5B,sBAcF,CAAA;AAED,eAAe,aAAa,CAAA"}
|
package/types/FormPropTypes.d.ts
CHANGED
|
@@ -3,6 +3,9 @@ import PropTypes from 'prop-types';
|
|
|
3
3
|
declare const formMessageTypePropType: PropTypes.Requireable<string>;
|
|
4
4
|
declare const formMessageChildPropType: PropTypes.Requireable<PropTypes.ReactNodeLike>;
|
|
5
5
|
type FormMessageType = 'newError' | 'error' | 'hint' | 'success' | 'screenreader-only';
|
|
6
|
+
/**
|
|
7
|
+
* The text to display in the form message
|
|
8
|
+
*/
|
|
6
9
|
type FormMessageChild = React.ReactNode;
|
|
7
10
|
/**
|
|
8
11
|
* ---
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FormPropTypes.d.ts","sourceRoot":"","sources":["../src/FormPropTypes.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,SAAS,MAAM,YAAY,CAAA;AAElC,QAAA,MAAM,uBAAuB,+BAM3B,CAAA;AACF,QAAA,MAAM,wBAAwB,gDAAiB,CAAA;AAE/C,KAAK,eAAe,GAChB,UAAU,GACV,OAAO,GACP,MAAM,GACN,SAAS,GACT,mBAAmB,CAAA;
|
|
1
|
+
{"version":3,"file":"FormPropTypes.d.ts","sourceRoot":"","sources":["../src/FormPropTypes.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,SAAS,MAAM,YAAY,CAAA;AAElC,QAAA,MAAM,uBAAuB,+BAM3B,CAAA;AACF,QAAA,MAAM,wBAAwB,gDAAiB,CAAA;AAE/C,KAAK,eAAe,GAChB,UAAU,GACV,OAAO,GACP,MAAM,GACN,SAAS,GACT,mBAAmB,CAAA;AAEvB;;GAEG;AACH,KAAK,gBAAgB,GAAG,KAAK,CAAC,SAAS,CAAA;AAEvC;;;;;;GAMG;AACH,QAAA,MAAM,aAAa;;;;;CAKlB,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,eAAe,CAAA;IACrB,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAED,eAAe,aAAa,CAAA;AAC5B,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,CAAA;AAC3E,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAA"}
|