@pine-ds/core 4.6.0 → 4.7.0

package/dist/types/components.d.ts

@@ -1430,12 +1430,13 @@ export namespace Components {
         "vertical": boolean;
     }
     /**
-     * A non-modal side panel composed from `pds-modal`.
-     * Unlike `pds-modal`, the page stays interactive while a drawer is open: no
-     * dimming, no blur, no scroll lock, no click blocking. `pds-drawer` renders a
-     * `pds-modal` internally with `disableTopLayer` always on and its backdrop
-     * suppressed, and adds the edge, width and dismiss behavior a side panel
-     * needs on top. It does not reimplement focus, Escape or dialog semantics —
+     * A side panel composed from `pds-modal`, non-modal by default.
+     * By default, unlike `pds-modal`, the page stays interactive while a drawer
+     * is open: no dimming, no blur, no scroll lock, no click blocking.
+     * `pds-drawer` renders a `pds-modal` internally with `disableTopLayer` on and
+     * its backdrop suppressed, and adds the edge, width and dismiss behavior a
+     * side panel needs on top. With `modal`, it opens that `pds-modal` in the top
+     * layer instead and keeps its backdrop. It does not reimplement focus, Escape or dialog semantics —
      * those come from `pds-modal` unchanged.
      * @lightDom renders-markup
      */
@@ -1445,15 +1446,20 @@ export namespace Components {
          */
         "componentId": string;
         /**
-          * Whether to move focus into the drawer when it opens. `auto` is right for a drawer opened by a direct user action (a click, a deep link the user just navigated to). Set to `none` for a drawer that can open from a background event while the user is mid-task elsewhere on the page — moving focus there would interrupt them, and the page stays live under a non-modal drawer, so it is a genuine data-entry risk, not just an annoyance.
+          * Whether to move focus into the drawer when it opens. `auto` is right for a drawer opened by a direct user action (a click, a deep link the user just navigated to). Set to `none` for a drawer that can open from a background event while the user is mid-task elsewhere on the page — moving focus there would interrupt them, and the page stays live under a non-modal drawer, so it is a genuine data-entry risk, not just an annoyance. A `modal` drawer ignores `none`: the page behind it is inert, so focus starts in the drawer.
           * @default 'auto'
          */
         "initialFocus": 'auto' | 'none';
         /**
-          * Whether the drawer can be dismissed with a pointerdown outside it. Replaces `pds-modal`'s `backdropDismiss` — there is no backdrop to click. This also gates Escape, matching how `backdropDismiss` gates Escape on `pds-modal` today: setting this to `false` means the close button is the only way out.  A trigger outside the drawer should only ever set `open` to `true` and leave closing to the drawer itself. A toggle-style trigger (`open = !open`) fights light dismiss: clicking it while open closes the drawer on `pointerdown`, then the trigger's own click handler re-opens it.
+          * Whether the drawer can be dismissed with a pointerdown outside it (in a `modal` drawer, a click on its backdrop). Replaces `pds-modal`'s `backdropDismiss`. This also gates Escape, matching how `backdropDismiss` gates Escape on `pds-modal` today: setting this to `false` means the close button is the only way out.  A trigger outside the drawer should only ever set `open` to `true` and leave closing to the drawer itself. A toggle-style trigger (`open = !open`) fights light dismiss: clicking it while open closes the drawer on `pointerdown`, then the trigger's own click handler re-opens it.
           * @default true
          */
         "lightDismiss": boolean;
+        /**
+          * Whether the drawer is modal. A modal drawer dims the page behind it with a backdrop, makes the page inert, and keeps focus inside the drawer, like `pds-modal`. Use it for a task the page should wait on. Leave it off for a panel people work alongside the page. Read when the drawer opens; changing it while the drawer is open is not supported.
+          * @default false
+         */
+        "modal": boolean;
         /**
           * Whether the drawer is open
           * @default false
@@ -1838,7 +1844,7 @@ export namespace Components {
      */
     interface PdsModal {
         /**
-          * Whether the modal can be dismissed by clicking the backdrop
+          * Whether the modal can be dismissed by clicking the backdrop, pressing Escape, or the browser's own close request (such as a back gesture)
           * @default true
          */
         "backdropDismiss": boolean;
@@ -3254,12 +3260,13 @@ declare global {
         "pdsDrawerClose": void;
     }
     /**
-     * A non-modal side panel composed from `pds-modal`.
-     * Unlike `pds-modal`, the page stays interactive while a drawer is open: no
-     * dimming, no blur, no scroll lock, no click blocking. `pds-drawer` renders a
-     * `pds-modal` internally with `disableTopLayer` always on and its backdrop
-     * suppressed, and adds the edge, width and dismiss behavior a side panel
-     * needs on top. It does not reimplement focus, Escape or dialog semantics —
+     * A side panel composed from `pds-modal`, non-modal by default.
+     * By default, unlike `pds-modal`, the page stays interactive while a drawer
+     * is open: no dimming, no blur, no scroll lock, no click blocking.
+     * `pds-drawer` renders a `pds-modal` internally with `disableTopLayer` on and
+     * its backdrop suppressed, and adds the edge, width and dismiss behavior a
+     * side panel needs on top. With `modal`, it opens that `pds-modal` in the top
+     * layer instead and keeps its backdrop. It does not reimplement focus, Escape or dialog semantics —
      * those come from `pds-modal` unchanged.
      * @lightDom renders-markup
      */
@@ -5284,12 +5291,13 @@ declare namespace LocalJSX {
         "vertical"?: boolean;
     }
     /**
-     * A non-modal side panel composed from `pds-modal`.
-     * Unlike `pds-modal`, the page stays interactive while a drawer is open: no
-     * dimming, no blur, no scroll lock, no click blocking. `pds-drawer` renders a
-     * `pds-modal` internally with `disableTopLayer` always on and its backdrop
-     * suppressed, and adds the edge, width and dismiss behavior a side panel
-     * needs on top. It does not reimplement focus, Escape or dialog semantics —
+     * A side panel composed from `pds-modal`, non-modal by default.
+     * By default, unlike `pds-modal`, the page stays interactive while a drawer
+     * is open: no dimming, no blur, no scroll lock, no click blocking.
+     * `pds-drawer` renders a `pds-modal` internally with `disableTopLayer` on and
+     * its backdrop suppressed, and adds the edge, width and dismiss behavior a
+     * side panel needs on top. With `modal`, it opens that `pds-modal` in the top
+     * layer instead and keeps its backdrop. It does not reimplement focus, Escape or dialog semantics —
      * those come from `pds-modal` unchanged.
      * @lightDom renders-markup
      */
@@ -5299,15 +5307,20 @@ declare namespace LocalJSX {
          */
         "componentId"?: string;
         /**
-          * Whether to move focus into the drawer when it opens. `auto` is right for a drawer opened by a direct user action (a click, a deep link the user just navigated to). Set to `none` for a drawer that can open from a background event while the user is mid-task elsewhere on the page — moving focus there would interrupt them, and the page stays live under a non-modal drawer, so it is a genuine data-entry risk, not just an annoyance.
+          * Whether to move focus into the drawer when it opens. `auto` is right for a drawer opened by a direct user action (a click, a deep link the user just navigated to). Set to `none` for a drawer that can open from a background event while the user is mid-task elsewhere on the page — moving focus there would interrupt them, and the page stays live under a non-modal drawer, so it is a genuine data-entry risk, not just an annoyance. A `modal` drawer ignores `none`: the page behind it is inert, so focus starts in the drawer.
           * @default 'auto'
          */
         "initialFocus"?: 'auto' | 'none';
         /**
-          * Whether the drawer can be dismissed with a pointerdown outside it. Replaces `pds-modal`'s `backdropDismiss` — there is no backdrop to click. This also gates Escape, matching how `backdropDismiss` gates Escape on `pds-modal` today: setting this to `false` means the close button is the only way out.  A trigger outside the drawer should only ever set `open` to `true` and leave closing to the drawer itself. A toggle-style trigger (`open = !open`) fights light dismiss: clicking it while open closes the drawer on `pointerdown`, then the trigger's own click handler re-opens it.
+          * Whether the drawer can be dismissed with a pointerdown outside it (in a `modal` drawer, a click on its backdrop). Replaces `pds-modal`'s `backdropDismiss`. This also gates Escape, matching how `backdropDismiss` gates Escape on `pds-modal` today: setting this to `false` means the close button is the only way out.  A trigger outside the drawer should only ever set `open` to `true` and leave closing to the drawer itself. A toggle-style trigger (`open = !open`) fights light dismiss: clicking it while open closes the drawer on `pointerdown`, then the trigger's own click handler re-opens it.
           * @default true
          */
         "lightDismiss"?: boolean;
+        /**
+          * Whether the drawer is modal. A modal drawer dims the page behind it with a backdrop, makes the page inert, and keeps focus inside the drawer, like `pds-modal`. Use it for a task the page should wait on. Leave it off for a panel people work alongside the page. Read when the drawer opens; changing it while the drawer is open is not supported.
+          * @default false
+         */
+        "modal"?: boolean;
         /**
           * Emitted when the drawer is closed
          */
@@ -5724,7 +5737,7 @@ declare namespace LocalJSX {
      */
     interface PdsModal {
         /**
-          * Whether the modal can be dismissed by clicking the backdrop
+          * Whether the modal can be dismissed by clicking the backdrop, pressing Escape, or the browser's own close request (such as a back gesture)
           * @default true
          */
         "backdropDismiss"?: boolean;
@@ -7200,6 +7213,7 @@ declare namespace LocalJSX {
         "side": 'start' | 'end';
         "size": 'sm' | 'md';
         "scrollable": boolean;
+        "modal": boolean;
         "lightDismiss": boolean;
         "initialFocus": 'auto' | 'none';
     }
@@ -7650,12 +7664,13 @@ declare module "@stencil/core" {
             "pds-datepicker": LocalJSX.IntrinsicElements["pds-datepicker"] & JSXBase.HTMLAttributes<HTMLPdsDatepickerElement>;
             "pds-divider": LocalJSX.IntrinsicElements["pds-divider"] & JSXBase.HTMLAttributes<HTMLPdsDividerElement>;
             /**
-             * A non-modal side panel composed from `pds-modal`.
-             * Unlike `pds-modal`, the page stays interactive while a drawer is open: no
-             * dimming, no blur, no scroll lock, no click blocking. `pds-drawer` renders a
-             * `pds-modal` internally with `disableTopLayer` always on and its backdrop
-             * suppressed, and adds the edge, width and dismiss behavior a side panel
-             * needs on top. It does not reimplement focus, Escape or dialog semantics —
+             * A side panel composed from `pds-modal`, non-modal by default.
+             * By default, unlike `pds-modal`, the page stays interactive while a drawer
+             * is open: no dimming, no blur, no scroll lock, no click blocking.
+             * `pds-drawer` renders a `pds-modal` internally with `disableTopLayer` on and
+             * its backdrop suppressed, and adds the edge, width and dismiss behavior a
+             * side panel needs on top. With `modal`, it opens that `pds-modal` in the top
+             * layer instead and keeps its backdrop. It does not reimplement focus, Escape or dialog semantics —
              * those come from `pds-modal` unchanged.
              * @lightDom renders-markup
              */

package/dist/vscode.html-data.json

@@ -8174,7 +8174,7 @@
       "name": "pds-drawer",
       "description": {
         "kind": "markdown",
-        "value": "A non-modal side panel. Unlike `pds-modal`, the page stays interactive while a drawer is open — no dimming, no blur, no scroll lock, no click blocking.\n\n**Events:**\n- `pdsDrawerClose` - Emitted when the drawer is closed\n- `pdsDrawerOpen` - Emitted when the drawer is opened"
+        "value": "A side panel. By default it's non-modal: unlike `pds-modal`, the page stays interactive while a drawer is open — no dimming, no blur, no scroll lock, no click blocking. Add `modal` for a drawer the page should wait on (see [Modal](#modal)).\n\n**Events:**\n- `pdsDrawerClose` - Emitted when the drawer is closed\n- `pdsDrawerOpen` - Emitted when the drawer is opened"
       },
       "attributes": [
         {
@@ -8188,7 +8188,7 @@
           "name": "initial-focus",
           "description": {
             "kind": "markdown",
-            "value": "Whether to move focus into the drawer when it opens. `auto` is right for\na drawer opened by a direct user action (a click, a deep link the user\njust navigated to). Set to `none` for a drawer that can open from a\nbackground event while the user is mid-task elsewhere on the page —\nmoving focus there would interrupt them, and the page stays live under\na non-modal drawer, so it is a genuine data-entry risk, not just an\nannoyance.\n\n**Type:** `\"auto\" | \"none\"`\n\n**Default:** `'auto'`"
+            "value": "Whether to move focus into the drawer when it opens. `auto` is right for\na drawer opened by a direct user action (a click, a deep link the user\njust navigated to). Set to `none` for a drawer that can open from a\nbackground event while the user is mid-task elsewhere on the page —\nmoving focus there would interrupt them, and the page stays live under\na non-modal drawer, so it is a genuine data-entry risk, not just an\nannoyance. A `modal` drawer ignores `none`: the page behind it is inert,\nso focus starts in the drawer.\n\n**Type:** `\"auto\" | \"none\"`\n\n**Default:** `'auto'`"
           },
           "values": [
             {
@@ -8203,7 +8203,14 @@
           "name": "light-dismiss",
           "description": {
             "kind": "markdown",
-            "value": "Whether the drawer can be dismissed with a pointerdown outside it.\nReplaces `pds-modal`'s `backdropDismiss` — there is no backdrop to click.\nThis also gates Escape, matching how `backdropDismiss` gates Escape on\n`pds-modal` today: setting this to `false` means the close button is the\nonly way out.\n\nA trigger outside the drawer should only ever set `open` to `true` and\nleave closing to the drawer itself. A toggle-style trigger (`open =\n!open`) fights light dismiss: clicking it while open closes the drawer\non `pointerdown`, then the trigger's own click handler re-opens it.\n\n**Default:** `true`"
+            "value": "Whether the drawer can be dismissed with a pointerdown outside it (in a\n`modal` drawer, a click on its backdrop).\nReplaces `pds-modal`'s `backdropDismiss`.\nThis also gates Escape, matching how `backdropDismiss` gates Escape on\n`pds-modal` today: setting this to `false` means the close button is the\nonly way out.\n\nA trigger outside the drawer should only ever set `open` to `true` and\nleave closing to the drawer itself. A toggle-style trigger (`open =\n!open`) fights light dismiss: clicking it while open closes the drawer\non `pointerdown`, then the trigger's own click handler re-opens it.\n\n**Default:** `true`"
+          }
+        },
+        {
+          "name": "modal",
+          "description": {
+            "kind": "markdown",
+            "value": "Whether the drawer is modal. A modal drawer dims the page behind it with a\nbackdrop, makes the page inert, and keeps focus inside the drawer, like\n`pds-modal`. Use it for a task the page should wait on. Leave it off for a\npanel people work alongside the page. Read when the drawer opens; changing\nit while the drawer is open is not supported.\n\n**Default:** `false`"
           }
         },
         {
@@ -9062,7 +9069,7 @@
           "name": "backdrop-dismiss",
           "description": {
             "kind": "markdown",
-            "value": "Whether the modal can be dismissed by clicking the backdrop\n\n**Default:** `true`"
+            "value": "Whether the modal can be dismissed by clicking the backdrop, pressing Escape, or the browser's\nown close request (such as a back gesture)\n\n**Default:** `true`"
           }
         },
         {