@genesislcap/foundation-forms 14.12.1-web-types.1 → 14.12.2-alpha-8f5bf34.0

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.
@@ -10,14 +10,12 @@ export declare const filtersRenderers: any[];
10
10
  * Foundation filters component for automatically generated filters based on json schema
11
11
  * obtained from the api, supplied initial data or supplied JSON schema.
12
12
  * Allowing customisable filters elements using UI schema and set of custom renderers
13
- * @element foundation-filters
14
13
  * @beta
15
14
  */
16
15
  export declare class Filters extends FoundationElement {
17
16
  /**
18
17
  * Name of the backend resource which will provide metadata
19
18
  * used to generate filters
20
- * @attr
21
19
  * @public
22
20
  */
23
21
  resourceName: string;
@@ -59,19 +57,16 @@ export declare class Filters extends FoundationElement {
59
57
  * ],
60
58
  * };
61
59
  * ```
62
- * @attr :uischema
63
60
  * @public
64
61
  */
65
62
  uischema: UISchemaElement;
66
63
  /**
67
64
  * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
68
- * @attr :renderers
69
65
  * @public
70
66
  */
71
67
  renderers: RendererEntry[];
72
68
  /**
73
69
  * Alternatively to providing {@link Form.resourceName} you can hardcode the JSON schema on the client.
74
- * @attr :jsonschema
75
70
  * @public
76
71
  * @remarks
77
72
  * Use this when you want to avoid fetching metadata from the server but
@@ -86,7 +81,6 @@ export declare class Filters extends FoundationElement {
86
81
  data: any;
87
82
  /**
88
83
  * Created criteria based on the given data that can be used to filter the data
89
- * @attr :value
90
84
  * @public
91
85
  */
92
86
  value: string;
@@ -1 +1 @@
1
- {"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/filters/filters.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,gBAAgB;AAChB,eAAO,MAAM,aAAa,gDAAqC,CAAC;AAchE,cAAc;AACd,eAAO,MAAM,gBAAgB,OAY5B,CAAC;AACF;;;;;;GAMG;AACH,qBAKa,OAAQ,SAAQ,iBAAiB;IAC5C;;;;;OAKG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAW1B,gBAAgB;IAKvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;;OAIG;IACS,SAAS,EAAE,aAAa,EAAE,CAAoB;IAC1D;;;;;;;OAOG;IACS,UAAU,EAAE,WAAW,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAC3B;;;;OAIG;IACS,KAAK,EAAE,MAAM,CAAC;IAC1B,YAAY;IAIZ;;OAEG;IACH,aAAa;IAuBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAO3B,oBAAoB;CAKrB"}
1
+ {"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/filters/filters.ts"],"names":[],"mappings":"AAGA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,gBAAgB;AAChB,eAAO,MAAM,aAAa,gDAAqC,CAAC;AAchE,cAAc;AACd,eAAO,MAAM,gBAAgB,OAY5B,CAAC;AACF;;;;;GAKG;AAEH,qBAKa,OAAQ,SAAQ,iBAAiB;IAC5C;;;;OAIG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAW1B,gBAAgB;IAKvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;OAGG;IACS,SAAS,EAAE,aAAa,EAAE,CAAoB;IAC1D;;;;;;OAMG;IACS,UAAU,EAAE,WAAW,CAAC;IAE3B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAC3B;;;OAGG;IACS,KAAK,EAAE,MAAM,CAAC;IAC1B,YAAY;IAIZ;;OAEG;IACH,aAAa;IAuBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAO3B,oBAAoB;CAKrB"}
@@ -10,14 +10,12 @@ export declare const renderers: any[];
10
10
  * Foundation form component for automatically generated forms based on json schema
11
11
  * obtained from the api, supplied initial data or supplied JSON schema.
12
12
  * Allowing customisable form elements using UI schema and set of custom renderers
13
- * @element foundation-form
14
13
  * @beta
15
14
  */
16
15
  export declare class Form extends FoundationElement {
17
16
  /**
18
17
  * Name of the backend resource which will provide metadata
19
18
  * used to generate form and later used for submitting data
20
- * @attr
21
19
  * @public
22
20
  */
23
21
  resourceName: string;
@@ -25,6 +23,7 @@ export declare class Form extends FoundationElement {
25
23
  private removeDataProperties;
26
24
  /**
27
25
  * UI schema used to define configuration of the layout and elements in the form
26
+ * Check {@link UiSchemaElement} for possible options
28
27
  *
29
28
  * @remarks
30
29
  * If not provided will be autogenerated based on json schema or initial data
@@ -59,13 +58,11 @@ export declare class Form extends FoundationElement {
59
58
  * };
60
59
  * ```
61
60
  * @public
62
- * @attr :uischema
63
61
  */
64
62
  uischema: UISchemaElement;
65
63
  /**
66
64
  * Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs
67
65
  * @public
68
- * @attr :renderers
69
66
  */
70
67
  renderers: RendererEntry[];
71
68
  /**
@@ -74,14 +71,12 @@ export declare class Form extends FoundationElement {
74
71
  * @remarks
75
72
  * Use this when you want to avoid fetching metadata from the server but
76
73
  * be aware that it could get out of sync if metadata changes on the server
77
- * @attr :jsonSchema
78
74
  */
79
75
  jsonSchema: JSONSchema7;
80
76
  private errors;
81
77
  private connect;
82
78
  /**
83
79
  * Initial data for the form
84
- * @attr :data
85
80
  * @public
86
81
  */
87
82
  data: any;
@@ -93,9 +88,6 @@ export declare class Form extends FoundationElement {
93
88
  * @internal
94
89
  */
95
90
  submitted: boolean;
96
- /**
97
- * @attr {boolean}
98
- */
99
91
  readonly: boolean;
100
92
  /**
101
93
  * @internal
@@ -1 +1 @@
1
- {"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/form.ts"],"names":[],"mappings":"AAEA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,MAAM,gDAAkC,CAAC;AActD,cAAc;AACd,eAAO,MAAM,SAAS,OAYrB,CAAC;AACF;;;;;;GAMG;AACH,qBAKa,IAAK,SAAQ,iBAAiB;IACzC;;;;;OAKG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAQjC,OAAO,CAAC,oBAAoB;IA0B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;;OAIG;IACS,SAAS,EAAE,aAAa,EAAE,CAAa;IACnD;;;;;;;OAOG;IACS,UAAU,EAAE,WAAW,CAAC;IAEpC,OAAO,CAAC,MAAM,CAAqB;IAC1B,OAAO,CAAC,OAAO,CAAW;IACnC;;;;OAIG;IACS,IAAI,EAAE,GAAG,CAAM;IAE3B;;OAEG;IACS,UAAU,EAAE,OAAO,CAAC;IAChC;;OAEG;IACS,SAAS,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACwB,QAAQ,EAAE,OAAO,CAAC;IAE7C;;OAEG;IACG,OAAO;IAwBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAQ3B,oBAAoB;CAMrB"}
1
+ {"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/form.ts"],"names":[],"mappings":"AAEA,OAAO,EAKL,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAc1C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,gBAAgB;AAChB,eAAO,MAAM,MAAM,gDAAkC,CAAC;AActD,cAAc;AACd,eAAO,MAAM,SAAS,OAYrB,CAAC;AACF;;;;;GAKG;AAEH,qBAKa,IAAK,SAAQ,iBAAiB;IACzC;;;;OAIG;IACG,YAAY,EAAE,MAAM,CAAC;YACb,mBAAmB;IAQjC,OAAO,CAAC,oBAAoB;IA0B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACS,QAAQ,EAAE,eAAe,CAAC;IACtC;;;OAGG;IACS,SAAS,EAAE,aAAa,EAAE,CAAa;IACnD;;;;;;OAMG;IACS,UAAU,EAAE,WAAW,CAAC;IAEpC,OAAO,CAAC,MAAM,CAAqB;IAC1B,OAAO,CAAC,OAAO,CAAW;IACnC;;;OAGG;IACS,IAAI,EAAE,GAAG,CAAM;IAE3B;;OAEG;IACS,UAAU,EAAE,OAAO,CAAC;IAChC;;OAEG;IACS,SAAS,EAAE,OAAO,CAAC;IAEJ,QAAQ,EAAE,OAAO,CAAC;IAE7C;;OAEG;IACG,OAAO;IAwBb;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW;IAQ3B,oBAAoB;CAMrB"}
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.34.4"
9
+ }
10
+ ]
11
+ }
@@ -48,7 +48,6 @@ export const filtersRenderers = [
48
48
  * Foundation filters component for automatically generated filters based on json schema
49
49
  * obtained from the api, supplied initial data or supplied JSON schema.
50
50
  * Allowing customisable filters elements using UI schema and set of custom renderers
51
- * @element foundation-filters
52
51
  * @beta
53
52
  */
54
53
  let Filters = class Filters extends FoundationElement {
@@ -56,7 +55,6 @@ let Filters = class Filters extends FoundationElement {
56
55
  super(...arguments);
57
56
  /**
58
57
  * Allows to provide set of renderers used by the filters. If not provided it will default to text-field inputs
59
- * @attr :renderers
60
58
  * @public
61
59
  */
62
60
  this.renderers = filtersRenderers;
package/dist/esm/form.js CHANGED
@@ -46,7 +46,6 @@ export const renderers = [
46
46
  * Foundation form component for automatically generated forms based on json schema
47
47
  * obtained from the api, supplied initial data or supplied JSON schema.
48
48
  * Allowing customisable form elements using UI schema and set of custom renderers
49
- * @element foundation-form
50
49
  * @beta
51
50
  */
52
51
  let Form = class Form extends FoundationElement {
@@ -55,13 +54,11 @@ let Form = class Form extends FoundationElement {
55
54
  /**
56
55
  * Allows to provide set of renderers used by the form. If not provided it will default to text-field inputs
57
56
  * @public
58
- * @attr :renderers
59
57
  */
60
58
  this.renderers = renderers;
61
59
  this.errors = [];
62
60
  /**
63
61
  * Initial data for the form
64
- * @attr :data
65
62
  * @public
66
63
  */
67
64
  this.data = {};