@supersoniks/concorde 5.0.3 → 5.0.5

package/docs/src/core/components/ui/modal/modal.md

@@ -1,68 +1,62 @@
-## Modal
+# Modal
+
+**`sonic-modal`** presents focused content in a `<dialog>` overlay with backdrop, enter/exit animation, and a built-in close control. Compose **`sonic-modal-title`** / **`sonic-modal-subtitle`** / **`sonic-modal-content`** / **`sonic-modal-actions`**, or use the default slot. Call **`show()`** on the element to open; use **`hideModal`** on action buttons or **`hide()`** from script. Set **`forceAction`** when dismissal must go through explicit actions only. Imperative dialogs: **`Modal.create()`** (also **`window.SonicModal`**).
+
+## Basic example
+
+Click the trigger to open. **`sonic-modal-actions`** lays out footer buttons; **`hideModal`** closes the modal on click. Scope form state with **`formDataProvider`** on **`sonic-modal-actions`** so child **`sonic-button`** elements share one publisher.
 
 <sonic-code>
   <template>
     <sonic-button onclick="document.getElementById('modalExample').show()">
-      Simple modal
+      Open modal
     </sonic-button>
     <sonic-modal id="modalExample">
-      <sonic-modal-title
-        >Lorem ipsum dolor sit amet <sonic-badge type="danger" size="sm">+33</sonic-badge></sonic-modal-title
-      >
-      <sonic-modal-subtitle>Donec sed vestibulum augue.</sonic-modal-subtitle>
+      <sonic-modal-title>
+        Export ready
+        <sonic-badge type="success" size="sm">New</sonic-badge>
+      </sonic-modal-title>
+      <sonic-modal-subtitle>Your report finished processing.</sonic-modal-subtitle>
       <sonic-modal-content>
-        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eget quam eu mi luctus faucibus.
+        Download the CSV now or review the summary in your dashboard before sharing.
       </sonic-modal-content>
       <sonic-modal-actions formDataProvider="ModalMiniForm">
-        <sonic-button FormCheckable  minWidth="8rem" value="true" name="click">
-          Click don't close
+        <sonic-button minWidth="8rem" value="true" name="click">
+          Save draft
         </sonic-button>
-        <sonic-button minWidth="8rem" type="success" hideModal>Confirm</sonic-button>
+        <sonic-button minWidth="8rem" type="success" hideModal>Download</sonic-button>
       </sonic-modal-actions>
     </sonic-modal>
   </template>
 </sonic-code>
 
+## Scrollable content
 
-## Long text
+Long copy scrolls inside the dialog. Default **`maxHeight`** is `90vh`. Default **`align`** is `left`.
 
 <sonic-code>
   <template>
-    <sonic-button onclick="document.getElementById('modalText').show()"> Long text </sonic-button>
+    <sonic-button onclick="document.getElementById('modalText').show()">Venue details</sonic-button>
     <sonic-modal align="left" id="modalText">
-      <sonic-modal-title>Infos et tarifs </sonic-modal-title>
+      <sonic-modal-title>Hours and tickets</sonic-modal-title>
       <sonic-modal-content>
         <div class="prose">
           <p>
-            <strong>Horaires d’ouverture </strong><br />
-            Du mercredi au samedi de 13h30 à 19h et le dimanche de 13h30 à 18h<br />
-            + horaires spécifiques pour événements ou festivals&nbsp;
+            <strong>Opening hours</strong><br />
+            Wednesday–Saturday, 1:30 p.m.–7:00 p.m.; Sunday, 1:30 p.m.–6:00 p.m.
           </p>
           <p>
-            <strong> Billetterie&nbsp;<br /></strong>
-            La participation à certains événements et activités est soumise à un système de billetterie avec achats ou
-            réservations disponibles en ligne ou au guichet.&nbsp;&nbsp;<strong><br /></strong>
+            <strong>Ticketing</strong><br />
+            Some events require online or box-office reservations. Prices vary by event; booking ahead is recommended when capacity is limited.
           </p>
           <p>
-            Les tarifs (Tarif plein / Tarif Réduit / Tarif Spécifique) sont indiqués pour chaque événement et peuvent
-            varier selon la nature de l’événement. Les tarifs sont identiques en ligne et au guichet. Il est néanmoins
-            conseillé de réserver les billets en avance pour s’assurer une place.
+            <strong>Contact</strong><br />
+            tickets@example.com · +33 3 28 33 48 33
           </p>
           <p>
-            L’accès au Skatepark, Fablab et Halle C sont soumis à adhésions. Les adhésions sont gratuites et
-            nominatives. Elle donnent accès aux espaces dans la limite des places disponibles.
-          </p>
-          <p>
-            <strong>+ d’infos <br /></strong>billetterie@laconditionpublique.com <br />+33 (0)328334833&nbsp;
-          </p>
-          <br />
-          <p>
-            <strong>Accès <br /></strong>14, place Faidherbe <br />59100 Roubaix <br />Métro / Tram : Arrêt
-            Eurotéléport, Ligne 2 <br />Bus / V’Lille : Arrêt Condition Publique&nbsp;
-          </p>
-          <p>
-            Accès handicapés : nous contacter avant votre venue au 03 28 33 48 33 ou par mail
-            billetterie@laconditionpublique.com
+            <strong>Access</strong><br />
+            14 Place Faidherbe, 59100 Roubaix<br />
+            Metro line 2, Eurotéléport stop
           </p>
         </div>
       </sonic-modal-content>
@@ -72,33 +66,44 @@
 
 ## Force action
 
+With **`forceAction`**, backdrop click, Escape, and the default close button are disabled. Provide **`sonic-modal-actions`** (or **`sonic-modal-close`**) so users can finish the flow.
+
 <sonic-code>
   <template>
-    <sonic-button onclick="document.getElementById('force').show()"> Force action to close</sonic-button>
+    <sonic-button onclick="document.getElementById('force').show()">Cookie consent</sonic-button>
     <sonic-modal forceAction id="force">
-      <sonic-modal-title>Do you want some cookies ? </sonic-modal-title>
+      <sonic-modal-title>Allow analytics cookies?</sonic-modal-title>
       <sonic-modal-content>
-        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eget quam eu mi luctus faucibus.
+        We use cookies to measure traffic and improve the product. You can change this later in settings.
       </sonic-modal-content>
-      <sonic-modal-actions >
-        <sonic-button hideModal minWidth="8rem"> Nope </sonic-button>
-        <sonic-button hideModal minWidth="8rem" type="success">Hell yes !</sonic-button>
+      <sonic-modal-actions>
+        <sonic-button hideModal minWidth="8rem">Decline</sonic-button>
+        <sonic-button hideModal minWidth="8rem" type="success">Accept</sonic-button>
       </sonic-modal-actions>
     </sonic-modal>
-    </sonic-modal>
   </template>
 </sonic-code>
 
 ## Custom dimensions
 
+Set **`width`** / **`height`** / **`maxWidth`** / **`maxHeight`** (CSS lengths). On narrow viewports the panel becomes a bottom sheet. Use **`rounded="none"`** for edge-to-edge media.
+
 <sonic-code>
   <template>
-    <sonic-button onclick="document.getElementById('CustomWidth').show()"> Custom width </sonic-button>
-    <sonic-modal maxHeight="50vh" maxWidth="90vw" width="100%" height="100%" id="CustomWidth">
+    <sonic-button onclick="document.getElementById('CustomWidth').show()">Image preview</sonic-button>
+    <sonic-modal
+      rounded="none"
+      maxHeight="50vh"
+      maxWidth="90vw"
+      width="100%"
+      height="100%"
+      id="CustomWidth"
+    >
       <sonic-image
         cover
         objectPosition="center 20%"
         src="https://thegoodlife.fr/wp-content/uploads/sites/2/2022/03/compagnies-aeriennes-nostalgie-coeur-insert-03-dr.jpg"
+        alt="View from an airplane window"
       ></sonic-image>
     </sonic-modal>
   </template>
@@ -106,14 +111,125 @@
 
 ## Fullscreen
 
+**`fullscreen`** fills the viewport and hides the backdrop.
+
 <sonic-code>
   <template>
-    <sonic-button onclick="document.getElementById('Fullscreen').show()"> Fullscreen </sonic-button>
+    <sonic-button onclick="document.getElementById('Fullscreen').show()">Fullscreen</sonic-button>
     <sonic-modal fullscreen id="Fullscreen">
       <sonic-image
         cover
         src="https://thegoodlife.fr/wp-content/uploads/sites/2/2022/03/compagnies-aeriennes-nostalgie-coeur-insert-03-dr.jpg"
+        alt="View from an airplane window"
       ></sonic-image>
     </sonic-modal>
   </template>
-</sonic-code>
+</sonic-code>
+
+## Programmatic creation
+
+Use **`Modal.create(options)`** when there is no modal in the template—for confirmations, toasts that need a follow-up, or one-off flows from script. The modal is appended to the nearest **`sonic-theme`** pop container (same as declarative modals), opened automatically, and returns the **`sonic-modal`** instance. Set **`removeOnHide: true`** to detach it from the DOM after close. In the browser, **`window.SonicModal`** is the same class after the module loads.
+
+Pass **`title`** / **`subtitle`** / **`content`** / **`actions`** as HTML strings (or Lit template results from application code). Put **`hideModal`** on action buttons in the **`actions`** string so clicks close the dialog.
+
+<sonic-code>
+  <template>
+    <sonic-button
+      onclick="window.SonicModal.create({
+        title: 'Send invite?',
+        subtitle: 'The recipient can join immediately.',
+        content: 'We will email an invitation to alex@example.com.',
+        actions: '&lt;sonic-button hideModal minWidth=\'8rem\'&gt;Cancel&lt;/sonic-button&gt;&lt;sonic-button hideModal minWidth=\'8rem\' type=\'success\'&gt;Send&lt;/sonic-button&gt;',
+        removeOnHide: true
+      })"
+    >
+      Open programmatic modal
+    </sonic-button>
+  </template>
+</sonic-code>
+
+<sonic-code language="javascript">
+  <template>
+import { Modal } from "@supersoniks/concorde/core/components/ui/modal/modal";
+
+const modal = Modal.create({
+  title: "Delete project?",
+  subtitle: "This cannot be undone.",
+  content: "<p>All files in <strong>Acme HQ</strong> will be removed.</p>",
+  actions: `
+    <sonic-button hideModal minWidth="8rem">Cancel</sonic-button>
+    <sonic-button hideModal minWidth="8rem" type="danger">Delete</sonic-button>
+  `,
+  removeOnHide: true,
+  forceAction: false,
+  maxWidth: "min(100vw, 28rem)",
+});
+
+modal.addEventListener("hidden", () => {
+  console.log("Modal removed from the DOM");
+});
+
+// Or close from script: await modal.hide(); await modal.dispose();
+  </template>
+</sonic-code>
+
+## API reference
+
+### `sonic-modal`
+
+| Attribute | Values | Description |
+|----------|---------|-------------|
+| `align` | `left` (default) · `center` · `right` | Align title and slotted content |
+| `maxWidth` | CSS length (default `min(100vw, 40rem)`) | Dialog max width |
+| `maxHeight` | CSS length (default `90vh`) | Scrollable body max height |
+| `width` | CSS length (default `100%`) | Dialog width |
+| `height` | CSS length (default `fit-content`) | Dialog height |
+| `paddingX` · `paddingY` | CSS length | Override content padding (`--sc-modal-px` / `--sc-modal-py`) |
+| `zIndex` | CSS number | Stacking order (default `990`) |
+| `effect` | `slide` (default) · `fade` · `none` | Open/close animation |
+| `fullscreen` | boolean | Full viewport; no backdrop |
+| `forceAction` | boolean | Disable overlay, Escape, and default close button |
+| `noCloseButton` | boolean | Hide built-in close when not **`forceAction`** |
+| `closeButtonType` | **`sonic-button`** `type` | Style of built-in close |
+| `visible` | boolean | When toggled, opens or closes the dialog |
+| `removeOnHide` | boolean | Remove element from DOM after close |
+| `removeHashOnHide` | boolean | Clear URL hash on close |
+| `closeOnLocationChange` | boolean | Close when app location changes |
+| `resetDataProviderOnHide` | string | Reset named **`formDataProvider`** on close |
+| `rounded` | `none` | Square dialog corners (useful for full-bleed media) |
+
+| Slot | Description |
+|------|-------------|
+| *(default)* | Additional markup alongside structured children |
+
+| Event | Description |
+|-------|-------------|
+| `show` | Fired when open animation completes |
+| `hide` | Fired when close starts |
+| `hidden` | Fired when close finishes |
+
+Methods: **`show()`** · **`hide()`** · **`dispose()`** (hide and remove). Static **`Modal.create(options)`** appends a modal to the theme pop container and opens it. **`options`** / **`styleSheet`** are JavaScript-only.
+
+### `sonic-modal-title` · `sonic-modal-subtitle` · `sonic-modal-content`
+
+| Slot | Description |
+|------|-------------|
+| *(default)* | Title, subtitle, or main body content |
+
+### `sonic-modal-actions`
+
+| Slot | Description |
+|------|-------------|
+| *(default)* | Footer actions (typically **`sonic-button`**) |
+
+Put **`hideModal`** on a **`sonic-button`** to close the parent modal on click. Ancestor **`formDataProvider`** on this element is inherited by child form controls.
+
+### `sonic-modal-close`
+
+Rendered automatically unless **`forceAction`** or **`noCloseButton`** is set. Calls **`hide()`** on the parent modal.
+
+| Attribute | Values | Description |
+|----------|---------|-------------|
+| `type` | **`sonic-button`** `type` | Close button color |
+| `reset` | string | Passed to inner **`sonic-button`** **`reset`** |
+| `translation` | UI label object | Overrides default close **`aria-label`** |