@zywave/zui-dialog - npm Package Compare versions

Comparing version 4.0.38 to 4.0.39-pre.0

dist/custom-elements.json

@@ -15,7 +15,21 @@ {
           "kind": "class",
-          "description": "`<zui-dialog>` is an overlay modal used to focus user's attention.\nNote: this component depends on `<dialog>` which may not be supported in older browsers. If not using the bundle, you'll require a polyfill. See https://github.com/GoogleChrome/dialog-polyfill for more info.",
+          "description": "`<zui-dialog>` is an overlay modal used to focus a user's attention.\nNote: this component depends on `<dialog>` which may not be supported in older browsers. If not using the bundle, you'll require a polyfill. See https://github.com/GoogleChrome/dialog-polyfill for more info.",
           "name": "ZuiDialogElement",
+          "cssParts": [
+            {
+              "description": "The header container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(header)`",
+              "name": "header"
+            },
+            {
+              "description": "The content container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(content)`",
+              "name": "content"
+            },
+            {
+              "description": "The footer container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(footer)`",
+              "name": "footer"
+            }
+          ],
           "slots": [
             {
-              "description": "Unnamed slot, for the body of the dialog",
+              "description": "Default, unnamed slot; for inserting content into the body of `<zui-dialog>`",
               "name": ""
@@ -28,7 +42,7 @@ },
             {
-              "description": "Slot for footer elements such as`<zui-button>`'s to close or confirm dialog",
+              "description": "Slot for footer elements such as `<zui-button>` elements to close or confirm the dialog",
               "name": "footer"
             },
             {
-              "description": "(deprecated): Use the unnamed slot instead",
+              "description": "Deprecated: Use the default, unnamed slot instead",
               "name": "content"
@@ -129,3 +143,3 @@ }
               },
-              "description": "Readonly. True if the dialog was canceled when it was last closed.",
+              "description": "Readonly; true if the dialog was canceled when it was last closed.",
               "default": "undefined | null"
@@ -253,3 +267,3 @@ },
               },
-              "description": "Open event dispatched once dialog is opened"
+              "description": "Event dispatches once dialog is opened"
             },
@@ -261,3 +275,3 @@ {
               },
-              "description": "Close event dispatches once dialog is closed, if it was a close by cancel `event.detail = false`, if close by confirm `event.detail = true`"
+              "description": "Event dispatches once dialog is closed. If the dialog was closed by cancelling, `event.detail = false`. If the dialog was closed by confirming, `event.detail = true`."
             }
@@ -270,3 +284,3 @@ ],
               },
-              "description": "Add this attribute to the corresponding footer element, when clicked it will cancel/close and will trigger the custom event 'close' with `event.detail=false`",
+              "description": "Add this attribute to the corresponding footer element; when clicked it will cancel, close the dialog, and trigger the custom event 'close' with `event.detail=false`",
               "name": "dialog-close",
@@ -279,3 +293,3 @@ "default": "false"
               },
-              "description": "Add this attribute to the corresponding footer element, when clicked it will confirm/close and will trigger the custom event 'close' with `event.detail=true`",
+              "description": "Add this attribute to the corresponding footer element; when clicked it will confirm, close the dialog, and trigger the custom event 'close' with `event.detail=true`",
               "name": "dialog-confirm",
@@ -288,3 +302,3 @@ "default": "false"
               },
-              "description": "Not recommended, attribute removes backdrop color",
+              "description": "Not recommended; this attribute removes the dialog backdrop color",
               "name": "hide-backdrop",
@@ -291,0 +305,0 @@ "default": "false"

dist/zui-dialog.d.ts

 import { ZuiBaseElement } from '@zywave/zui-base';
 export declare const SUPPORTS_HTML_DIALOG: VoidFunction & (() => void);
 /**
- * `<zui-dialog>` is an overlay modal used to focus user's attention.
+ * `<zui-dialog>` is an overlay modal used to focus a user's attention.
  * Note: this component depends on `<dialog>` which may not be supported in older browsers. If not using the bundle, you'll require a polyfill. See https://github.com/GoogleChrome/dialog-polyfill for more info.
@@ -9,15 +9,19 @@ *
  *
- * @slot - Unnamed slot, for the body of the dialog
+ * @slot - Default, unnamed slot; for inserting content into the body of `<zui-dialog>`
  * @slot header - Slot for title text
- * @slot footer - Slot for footer elements such as`<zui-button>`'s to close or confirm dialog
- * @slot content - (deprecated): Use the unnamed slot instead
+ * @slot footer - Slot for footer elements such as `<zui-button>` elements to close or confirm the dialog
+ * @slot content - Deprecated: Use the default, unnamed slot instead
  *
- * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element, when clicked it will cancel/close and will trigger the custom event 'close' with `event.detail=false`
- * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element, when clicked it will confirm/close and will trigger the custom event 'close' with `event.detail=true`
- * @attr {boolean} [hide-backdrop=false] - Not recommended, attribute removes backdrop color
+ * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element; when clicked it will cancel, close the dialog, and trigger the custom event 'close' with `event.detail=false`
+ * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element; when clicked it will confirm, close the dialog, and trigger the custom event 'close' with `event.detail=true`
+ * @attr {boolean} [hide-backdrop=false] - Not recommended; this attribute removes the dialog backdrop color
  *
- * @prop {boolean} [canceled=undefined | null] - Readonly. True if the dialog was canceled when it was last closed.
+ * @csspart header - The header container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(header)`
+ * @csspart content - The content container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(content)`
+ * @csspart footer - The footer container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(footer)`
  *
- * @event close - Close event dispatches once dialog is closed, if it was a close by cancel `event.detail = false`, if close by confirm `event.detail = true`
- * @event open - Open event dispatched once dialog is opened
+ * @prop {boolean} [canceled=undefined | null] - Readonly; true if the dialog was canceled when it was last closed.
+ *
+ * @event close - Event dispatches once dialog is closed. If the dialog was closed by cancelling, `event.detail = false`. If the dialog was closed by confirming, `event.detail = true`.
+ * @event open - Event dispatches once dialog is opened
  */
@@ -24,0 +28,0 @@ export declare class ZuiDialogElement extends ZuiBaseElement {

dist/zui-dialog.js

@@ -26,3 +26,3 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
 /**
- * `<zui-dialog>` is an overlay modal used to focus user's attention.
+ * `<zui-dialog>` is an overlay modal used to focus a user's attention.
  * Note: this component depends on `<dialog>` which may not be supported in older browsers. If not using the bundle, you'll require a polyfill. See https://github.com/GoogleChrome/dialog-polyfill for more info.
@@ -32,15 +32,19 @@ *
  *
- * @slot - Unnamed slot, for the body of the dialog
+ * @slot - Default, unnamed slot; for inserting content into the body of `<zui-dialog>`
  * @slot header - Slot for title text
- * @slot footer - Slot for footer elements such as`<zui-button>`'s to close or confirm dialog
- * @slot content - (deprecated): Use the unnamed slot instead
+ * @slot footer - Slot for footer elements such as `<zui-button>` elements to close or confirm the dialog
+ * @slot content - Deprecated: Use the default, unnamed slot instead
  *
- * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element, when clicked it will cancel/close and will trigger the custom event 'close' with `event.detail=false`
- * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element, when clicked it will confirm/close and will trigger the custom event 'close' with `event.detail=true`
- * @attr {boolean} [hide-backdrop=false] - Not recommended, attribute removes backdrop color
+ * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element; when clicked it will cancel, close the dialog, and trigger the custom event 'close' with `event.detail=false`
+ * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element; when clicked it will confirm, close the dialog, and trigger the custom event 'close' with `event.detail=true`
+ * @attr {boolean} [hide-backdrop=false] - Not recommended; this attribute removes the dialog backdrop color
  *
- * @prop {boolean} [canceled=undefined | null] - Readonly. True if the dialog was canceled when it was last closed.
+ * @csspart header - The header container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(header)`
+ * @csspart content - The content container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(content)`
+ * @csspart footer - The footer container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(footer)`
  *
- * @event close - Close event dispatches once dialog is closed, if it was a close by cancel `event.detail = false`, if close by confirm `event.detail = true`
- * @event open - Open event dispatched once dialog is opened
+ * @prop {boolean} [canceled=undefined | null] - Readonly; true if the dialog was canceled when it was last closed.
+ *
+ * @event close - Event dispatches once dialog is closed. If the dialog was closed by cancelling, `event.detail = false`. If the dialog was closed by confirming, `event.detail = true`.
+ * @event open - Event dispatches once dialog is opened
  */
@@ -47,0 +51,0 @@ export class ZuiDialogElement extends ZuiBaseElement {

package.json

 {
   "name": "@zywave/zui-dialog",
-  "version": "4.0.38",
+  "version": "4.0.39-pre.0",
   "main": "dist/index.js",
@@ -28,3 +28,3 @@ "module": "dist/index.js",
   "customElements": "dist/custom-elements.json",
-  "gitHead": "29ee30ce78d0cf12a2ee9390dab564815330ebd0"
+  "gitHead": "9d50c40cc4eab86fc94b863161f2ee862f72eb12"
 }

src/zui-dialog.ts

@@ -10,3 +10,3 @@ import { ZuiBaseElement } from '@zywave/zui-base';
 /**
- * `<zui-dialog>` is an overlay modal used to focus user's attention.
+ * `<zui-dialog>` is an overlay modal used to focus a user's attention.
  * Note: this component depends on `<dialog>` which may not be supported in older browsers. If not using the bundle, you'll require a polyfill. See https://github.com/GoogleChrome/dialog-polyfill for more info.
@@ -16,15 +16,19 @@ *
  *
- * @slot - Unnamed slot, for the body of the dialog
+ * @slot - Default, unnamed slot; for inserting content into the body of `<zui-dialog>`
  * @slot header - Slot for title text
- * @slot footer - Slot for footer elements such as`<zui-button>`'s to close or confirm dialog
- * @slot content - (deprecated): Use the unnamed slot instead
+ * @slot footer - Slot for footer elements such as `<zui-button>` elements to close or confirm the dialog
+ * @slot content - Deprecated: Use the default, unnamed slot instead
  *
- * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element, when clicked it will cancel/close and will trigger the custom event 'close' with `event.detail=false`
- * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element, when clicked it will confirm/close and will trigger the custom event 'close' with `event.detail=true`
- * @attr {boolean} [hide-backdrop=false] - Not recommended, attribute removes backdrop color
+ * @attr {boolean} [dialog-close=false] - Add this attribute to the corresponding footer element; when clicked it will cancel, close the dialog, and trigger the custom event 'close' with `event.detail=false`
+ * @attr {boolean} [dialog-confirm=false] - Add this attribute to the corresponding footer element; when clicked it will confirm, close the dialog, and trigger the custom event 'close' with `event.detail=true`
+ * @attr {boolean} [hide-backdrop=false] - Not recommended; this attribute removes the dialog backdrop color
  *
- * @prop {boolean} [canceled=undefined | null] - Readonly. True if the dialog was canceled when it was last closed.
+ * @csspart header - The header container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(header)`
+ * @csspart content - The content container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(content)`
+ * @csspart footer - The footer container inside `<zui-dialog>`; this is exposed as a CSS shadow part and can be accessed with `::part(footer)`
  *
- * @event close - Close event dispatches once dialog is closed, if it was a close by cancel `event.detail = false`, if close by confirm `event.detail = true`
- * @event open - Open event dispatched once dialog is opened
+ * @prop {boolean} [canceled=undefined | null] - Readonly; true if the dialog was canceled when it was last closed.
+ *
+ * @event close - Event dispatches once dialog is closed. If the dialog was closed by cancelling, `event.detail = false`. If the dialog was closed by confirming, `event.detail = true`.
+ * @event open - Event dispatches once dialog is opened
  */
@@ -31,0 +35,0 @@ export class ZuiDialogElement extends ZuiBaseElement {

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

139160

increased by2.21%

Lines of code

1364

increased by2.02%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes