@skyux/inline-form 8.3.0 → 8.4.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.
Files changed (6) hide show
  1. package/documentation.json +7 -7
  2. package/esm2020/lib/modules/inline-form/types/inline-form-button-config.mjs +1 -1
  3. package/esm2020/lib/modules/inline-form/types/inline-form-close-args.mjs +1 -1
  4. package/lib/modules/inline-form/types/inline-form-button-config.d.ts +3 -2
  5. package/lib/modules/inline-form/types/inline-form-close-args.d.ts +3 -2
  6. package/package.json +3 -3
package/documentation.json CHANGED
@@ -773,7 +773,7 @@
773
773
  "kindString": "Property",
774
774
  "flags": {},
775
775
  "comment": {
776
- "shortText": "The action that the button performs.\nThe valid options are `cancel`, `delete`, `done`, and `save`.",
776
+ "shortText": "The `string` value to return when users click a custom button.\nThis correlates to the `reason` in `SkyInlineFormCloseArgs`.\nThe standard values are `cancel`, `delete`, `done`, and `save`, but other custom values are also allowed.",
777
777
  "tags": [
778
778
  {
779
779
  "tag": "required",
@@ -784,7 +784,7 @@
784
784
  "sources": [
785
785
  {
786
786
  "fileName": "projects/inline-form/src/modules/inline-form/types/inline-form-button-config.ts",
787
- "line": 10,
787
+ "line": 11,
788
788
  "character": 2
789
789
  }
790
790
  ],
@@ -813,7 +813,7 @@
813
813
  "sources": [
814
814
  {
815
815
  "fileName": "projects/inline-form/src/modules/inline-form/types/inline-form-button-config.ts",
816
- "line": 22,
816
+ "line": 23,
817
817
  "character": 2
818
818
  }
819
819
  ],
@@ -836,7 +836,7 @@
836
836
  "sources": [
837
837
  {
838
838
  "fileName": "projects/inline-form/src/modules/inline-form/types/inline-form-button-config.ts",
839
- "line": 30,
839
+ "line": 31,
840
840
  "character": 2
841
841
  }
842
842
  ],
@@ -863,7 +863,7 @@
863
863
  "sources": [
864
864
  {
865
865
  "fileName": "projects/inline-form/src/modules/inline-form/types/inline-form-button-config.ts",
866
- "line": 16,
866
+ "line": 17,
867
867
  "character": 2
868
868
  }
869
869
  ],
@@ -907,12 +907,12 @@
907
907
  "kindString": "Property",
908
908
  "flags": {},
909
909
  "comment": {
910
- "shortText": "Returns a `string` value that explains why the inline form closed.\nThe possible values are `cancel`, `delete`, `done`, and `save`."
910
+ "shortText": "Returns a `string` value to explain why users clicked a custom button and initiated a `close` event.\nThis correlates to either the `action` in `SkyInlineFormButtonConfig` for custom buttons or the standard\nvalue of `cancel`, `delete`, `done`, or `save` for predefined buttons."
911
911
  },
912
912
  "sources": [
913
913
  {
914
914
  "fileName": "projects/inline-form/src/modules/inline-form/types/inline-form-close-args.ts",
915
- "line": 6,
915
+ "line": 7,
916
916
  "character": 2
917
917
  }
918
918
  ],
package/esm2020/lib/modules/inline-form/types/inline-form-button-config.mjs CHANGED
@@ -1,2 +1,2 @@
1
1
  export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5saW5lLWZvcm0tYnV0dG9uLWNvbmZpZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvY29tcG9uZW50cy9pbmxpbmUtZm9ybS9zcmMvbGliL21vZHVsZXMvaW5saW5lLWZvcm0vdHlwZXMvaW5saW5lLWZvcm0tYnV0dG9uLWNvbmZpZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBTcGVjaWZpZXMgY29uZmlndXJhdGlvbiBvcHRpb25zIGZvciB0aGUgaW5saW5lIGZvcm0ncyBidXR0b25zIHdoZW4gYGJ1dHRvbkxheW91dGAgaXMgc2V0IHRvIGBDdXN0b21gLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIFNreUlubGluZUZvcm1CdXR0b25Db25maWcge1xuICAvKipcbiAgICogVGhlIGFjdGlvbiB0aGF0IHRoZSBidXR0b24gcGVyZm9ybXMuXG4gICAqIFRoZSB2YWxpZCBvcHRpb25zIGFyZSBgY2FuY2VsYCwgYGRlbGV0ZWAsIGBkb25lYCwgYW5kIGBzYXZlYC5cbiAgICogQHJlcXVpcmVkXG4gICAqL1xuICBhY3Rpb246IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIGxhYmVsIGZvciB0aGUgYnV0dG9uLlxuICAgKiBAcmVxdWlyZWRcbiAgICovXG4gIHRleHQ6IHN0cmluZztcblxuICAvKipcbiAgICogV2hldGhlciB0byBkaXNhYmxlIHRoZSBidXR0b24uXG4gICAqIEBkZWZhdWx0IGZhbHNlXG4gICAqL1xuICBkaXNhYmxlZD86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIFRoZSBiYWNrZ3JvdW5kIGNvbG9yIGFuZCBzdHlsZSBmb3IgdGhlIGJ1dHRvbi5cbiAgICogVGhlIHZhbGlkIG9wdGlvbnMgYXJlIGBkZWZhdWx0YCwgYGxpbmtgLCBhbmQgYHByaW1hcnlgLlxuICAgKiBUaGVzZSB2YWx1ZXMgc2V0IHRoZSBiYWNrZ3JvdW5kIGNvbG9yIGFuZCBzdHlsZSBmcm9tIHRoZVxuICAgKiBbc2Vjb25kYXJ5LCBsaW5rLCBhbmQgcHJpbWFyeSBidXR0b24gY2xhc3Nlc10oaHR0cHM6Ly9kZXZlbG9wZXIuYmxhY2tiYXVkLmNvbS9za3l1eC9jb21wb25lbnRzL2J1dHRvbikgcmVzcGVjdGl2ZWx5LlxuICAgKi9cbiAgc3R5bGVUeXBlPzogc3RyaW5nO1xufVxuIl19
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5saW5lLWZvcm0tYnV0dG9uLWNvbmZpZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvY29tcG9uZW50cy9pbmxpbmUtZm9ybS9zcmMvbGliL21vZHVsZXMvaW5saW5lLWZvcm0vdHlwZXMvaW5saW5lLWZvcm0tYnV0dG9uLWNvbmZpZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBTcGVjaWZpZXMgY29uZmlndXJhdGlvbiBvcHRpb25zIGZvciB0aGUgaW5saW5lIGZvcm0ncyBidXR0b25zIHdoZW4gYGJ1dHRvbkxheW91dGAgaXMgc2V0IHRvIGBDdXN0b21gLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIFNreUlubGluZUZvcm1CdXR0b25Db25maWcge1xuICAvKipcbiAgICogVGhlIGBzdHJpbmdgIHZhbHVlIHRvIHJldHVybiB3aGVuIHVzZXJzIGNsaWNrIGEgY3VzdG9tIGJ1dHRvbi5cbiAgICogVGhpcyBjb3JyZWxhdGVzIHRvIHRoZSBgcmVhc29uYCBpbiBgU2t5SW5saW5lRm9ybUNsb3NlQXJnc2AuXG4gICAqIFRoZSBzdGFuZGFyZCB2YWx1ZXMgYXJlIGBjYW5jZWxgLCBgZGVsZXRlYCwgYGRvbmVgLCBhbmQgYHNhdmVgLCBidXQgb3RoZXIgY3VzdG9tIHZhbHVlcyBhcmUgYWxzbyBhbGxvd2VkLlxuICAgKiBAcmVxdWlyZWRcbiAgICovXG4gIGFjdGlvbjogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBUaGUgbGFiZWwgZm9yIHRoZSBidXR0b24uXG4gICAqIEByZXF1aXJlZFxuICAgKi9cbiAgdGV4dDogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBXaGV0aGVyIHRvIGRpc2FibGUgdGhlIGJ1dHRvbi5cbiAgICogQGRlZmF1bHQgZmFsc2VcbiAgICovXG4gIGRpc2FibGVkPzogYm9vbGVhbjtcblxuICAvKipcbiAgICogVGhlIGJhY2tncm91bmQgY29sb3IgYW5kIHN0eWxlIGZvciB0aGUgYnV0dG9uLlxuICAgKiBUaGUgdmFsaWQgb3B0aW9ucyBhcmUgYGRlZmF1bHRgLCBgbGlua2AsIGFuZCBgcHJpbWFyeWAuXG4gICAqIFRoZXNlIHZhbHVlcyBzZXQgdGhlIGJhY2tncm91bmQgY29sb3IgYW5kIHN0eWxlIGZyb20gdGhlXG4gICAqIFtzZWNvbmRhcnksIGxpbmssIGFuZCBwcmltYXJ5IGJ1dHRvbiBjbGFzc2VzXShodHRwczovL2RldmVsb3Blci5ibGFja2JhdWQuY29tL3NreXV4L2NvbXBvbmVudHMvYnV0dG9uKSByZXNwZWN0aXZlbHkuXG4gICAqL1xuICBzdHlsZVR5cGU/OiBzdHJpbmc7XG59XG4iXX0=
package/esm2020/lib/modules/inline-form/types/inline-form-close-args.mjs CHANGED
@@ -1,2 +1,2 @@
1
1
  export {};
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5saW5lLWZvcm0tY2xvc2UtYXJncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvY29tcG9uZW50cy9pbmxpbmUtZm9ybS9zcmMvbGliL21vZHVsZXMvaW5saW5lLWZvcm0vdHlwZXMvaW5saW5lLWZvcm0tY2xvc2UtYXJncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBTa3lJbmxpbmVGb3JtQ2xvc2VBcmdzIHtcbiAgLyoqXG4gICAqIFJldHVybnMgYSBgc3RyaW5nYCB2YWx1ZSB0aGF0IGV4cGxhaW5zIHdoeSB0aGUgaW5saW5lIGZvcm0gY2xvc2VkLlxuICAgKiBUaGUgcG9zc2libGUgdmFsdWVzIGFyZSBgY2FuY2VsYCwgYGRlbGV0ZWAsIGBkb25lYCwgYW5kIGBzYXZlYC5cbiAgICovXG4gIHJlYXNvbjogc3RyaW5nO1xufVxuIl19
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5saW5lLWZvcm0tY2xvc2UtYXJncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvY29tcG9uZW50cy9pbmxpbmUtZm9ybS9zcmMvbGliL21vZHVsZXMvaW5saW5lLWZvcm0vdHlwZXMvaW5saW5lLWZvcm0tY2xvc2UtYXJncy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IGludGVyZmFjZSBTa3lJbmxpbmVGb3JtQ2xvc2VBcmdzIHtcbiAgLyoqXG4gICAqIFJldHVybnMgYSBgc3RyaW5nYCB2YWx1ZSB0byBleHBsYWluIHdoeSB1c2VycyBjbGlja2VkIGEgY3VzdG9tIGJ1dHRvbiBhbmQgaW5pdGlhdGVkIGEgYGNsb3NlYCBldmVudC5cbiAgICogVGhpcyBjb3JyZWxhdGVzIHRvIGVpdGhlciB0aGUgYGFjdGlvbmAgaW4gYFNreUlubGluZUZvcm1CdXR0b25Db25maWdgIGZvciBjdXN0b20gYnV0dG9ucyBvciB0aGUgc3RhbmRhcmRcbiAgICogdmFsdWUgb2YgYGNhbmNlbGAsIGBkZWxldGVgLCBgZG9uZWAsIG9yIGBzYXZlYCBmb3IgcHJlZGVmaW5lZCBidXR0b25zLlxuICAgKi9cbiAgcmVhc29uOiBzdHJpbmc7XG59XG4iXX0=
package/lib/modules/inline-form/types/inline-form-button-config.d.ts CHANGED
@@ -3,8 +3,9 @@
3
3
  */
4
4
  export interface SkyInlineFormButtonConfig {
5
5
  /**
6
- * The action that the button performs.
7
- * The valid options are `cancel`, `delete`, `done`, and `save`.
6
+ * The `string` value to return when users click a custom button.
7
+ * This correlates to the `reason` in `SkyInlineFormCloseArgs`.
8
+ * The standard values are `cancel`, `delete`, `done`, and `save`, but other custom values are also allowed.
8
9
  * @required
9
10
  */
10
11
  action: string;
package/lib/modules/inline-form/types/inline-form-close-args.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  export interface SkyInlineFormCloseArgs {
2
2
  /**
3
- * Returns a `string` value that explains why the inline form closed.
4
- * The possible values are `cancel`, `delete`, `done`, and `save`.
3
+ * Returns a `string` value to explain why users clicked a custom button and initiated a `close` event.
4
+ * This correlates to either the `action` in `SkyInlineFormButtonConfig` for custom buttons or the standard
5
+ * value of `cancel`, `delete`, `done`, or `save` for predefined buttons.
5
6
  */
6
7
  reason: string;
7
8
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/inline-form",
3
- "version": "8.3.0",
3
+ "version": "8.4.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -35,8 +35,8 @@
35
35
  "@angular/animations": "^15.2.9",
36
36
  "@angular/common": "^15.2.9",
37
37
  "@angular/core": "^15.2.9",
38
- "@skyux/core": "8.3.0",
39
- "@skyux/i18n": "8.3.0"
38
+ "@skyux/core": "8.4.0",
39
+ "@skyux/i18n": "8.4.0"
40
40
  },
41
41
  "dependencies": {
42
42
  "tslib": "^2.5.0"