@datatechsolutions/tympan 0.3.0 → 0.3.1

package/src/components/sectioned-modal/SectionedModal.css

@@ -0,0 +1,325 @@
+/*
+ * SectionedModal (spec: wave-2/sectioned-modal.md; design direction §2.4, §2.5, §2.7, §2.8).
+ * Organised by part. Each part carries its own states, breakpoints and
+ * preference queries nested inside it; sizes and layout switches are read
+ * from --ty-smd-* properties so a breakpoint only has to change a value.
+ */
+@layer tympan.components {
+  /* Veil behind the panel. */
+  .ty-sectioned-modal__backdrop {
+    position: fixed;
+    inset: 0;
+    z-index: var(--ty-z-modal);
+    display: grid;
+    place-items: center;
+    padding: var(--ty-space-5);
+    background: var(--ty-backdrop);
+
+    &[data-entering] {
+      animation: ty-smd-fade var(--ty-dur-base) var(--ty-ease);
+    }
+    @media (prefers-reduced-transparency: reduce) {
+      background: rgb(15 23 42 / 0.6);
+    }
+  }
+
+  /* Panel (level 4). */
+  .ty-sectioned-modal {
+    --ty-smd-width: 52rem;
+    --ty-smd-pad-x: var(--ty-space-6);
+    --ty-smd-margin: var(--ty-space-5);
+    --ty-smd-direction: row;
+    --ty-smd-nav-width: 15rem;
+    --ty-smd-current: inset calc(3px * var(--ty-inline-sign)) 0 0 var(--ty-accent);
+
+    display: flex;
+    box-sizing: border-box;
+    inline-size: min(var(--ty-smd-width), 100%);
+    max-block-size: calc(100dvh - var(--ty-smd-margin) * 2);
+    overflow: hidden;
+    color: var(--ty-on-surface-raised);
+    background: var(--ty-surface-raised);
+    border: 1px solid var(--ty-line);
+    border-radius: var(--ty-radius-sheet);
+    box-shadow: var(--ty-shadow-modal);
+    backdrop-filter: blur(var(--ty-glass-blur-floating)) saturate(var(--ty-glass-saturate));
+    -webkit-backdrop-filter: blur(var(--ty-glass-blur-floating)) saturate(var(--ty-glass-saturate));
+    outline: none;
+
+    &[data-size='sm'] {
+      --ty-smd-width: 28rem;
+    }
+    &[data-size='md'] {
+      --ty-smd-width: 40rem;
+    }
+    &[data-size='xl'] {
+      --ty-smd-width: 68rem;
+    }
+    &[data-size='full'] {
+      --ty-smd-width: 100%;
+      block-size: 100%;
+    }
+    &[data-entering] {
+      animation: ty-smd-lift var(--ty-dur-base) var(--ty-ease);
+    }
+
+    @media (max-width: 1023.98px) {
+      --ty-smd-direction: column;
+      --ty-smd-nav-width: auto;
+      --ty-smd-current: inset 0 -3px 0 var(--ty-accent);
+    }
+    @media (prefers-reduced-motion: reduce) {
+      &[data-entering] {
+        animation: ty-smd-fade var(--ty-dur-base) linear;
+      }
+    }
+    @media (prefers-reduced-transparency: reduce) {
+      background: var(--ty-surface-raised-solid);
+      backdrop-filter: none;
+    }
+    @media (forced-colors: active) {
+      border: 1px solid CanvasText;
+      backdrop-filter: none;
+    }
+  }
+
+  /* Shrinkable columns and the frame that places navigation and content. */
+  :is(.ty-sectioned-modal__dialog, .ty-sectioned-modal__form, .ty-sectioned-modal__body) {
+    display: flex;
+    flex: 1;
+    flex-direction: column;
+    min-inline-size: 0;
+    min-block-size: 0;
+    outline: none;
+  }
+  .ty-sectioned-modal__frame {
+    display: flex;
+    flex: 1;
+    flex-direction: var(--ty-smd-direction);
+    min-block-size: 0;
+  }
+
+  /* Header block. */
+  .ty-sectioned-modal__head {
+    position: relative;
+    display: flex;
+    align-items: flex-start;
+    gap: var(--ty-space-3);
+    padding: var(--ty-space-5) var(--ty-smd-pad-x);
+    border-block-end: 1px solid var(--ty-line);
+
+    &[data-accent]::before {
+      content: '';
+      position: absolute;
+      inset-inline: 0;
+      inset-block-start: 0;
+      block-size: 3px;
+      background: var(--ty-accent);
+    }
+  }
+  .ty-sectioned-modal__head-icon {
+    display: inline-grid;
+    place-items: center;
+    inline-size: 40px;
+    block-size: 40px;
+    color: var(--ty-ink-2);
+    background: var(--ty-surface-sunken);
+    border-radius: var(--ty-radius-control);
+  }
+  .ty-sectioned-modal__titles {
+    flex: 1;
+    min-inline-size: 0;
+  }
+  .ty-sectioned-modal__title {
+    margin: 0;
+    color: var(--ty-ink);
+    font-family: var(--ty-font-serif);
+    font-size: var(--ty-font-size-h2);
+    font-weight: var(--ty-font-weight-semibold);
+    line-height: var(--ty-font-line-height-h2);
+    outline: none;
+
+    &:focus-visible {
+      outline: var(--ty-focus-width) solid var(--ty-focus-ring);
+      outline-offset: 2px;
+    }
+  }
+  .ty-sectioned-modal__subtitle {
+    margin: var(--ty-space-1) 0 0;
+    color: var(--ty-ink-3);
+  }
+  .ty-sectioned-modal__head-actions {
+    display: flex;
+    gap: var(--ty-space-2);
+  }
+  :is(.ty-sectioned-modal__eyebrow, .ty-sectioned-modal__group-name) {
+    margin: 0;
+    color: var(--ty-ink-3);
+    font-size: var(--ty-font-size-eyebrow);
+    font-weight: var(--ty-font-weight-semibold);
+    letter-spacing: var(--ty-font-tracking-eyebrow);
+    text-transform: uppercase;
+  }
+
+  /* Navigation between sections. */
+  .ty-sectioned-modal__rail {
+    display: flex;
+    flex: none;
+    flex-direction: column;
+    gap: var(--ty-space-4);
+    inline-size: var(--ty-smd-nav-width);
+    padding: var(--ty-space-4);
+    overflow-y: auto;
+    background: var(--ty-surface-sunken);
+    border-inline-end: 1px solid var(--ty-line);
+
+    @media (max-width: 1023.98px) {
+      flex-direction: row;
+      align-items: center;
+      padding: var(--ty-space-2) var(--ty-space-4);
+      overflow-x: auto;
+      border-inline-end: 0;
+      border-block-end: 1px solid var(--ty-line);
+    }
+  }
+  .ty-sectioned-modal__nav {
+    display: flex;
+    flex-direction: column;
+    gap: var(--ty-space-4);
+  }
+  .ty-sectioned-modal__list {
+    display: flex;
+    flex-direction: column;
+    gap: 2px;
+    margin: 0;
+    padding: 0;
+    list-style: none;
+  }
+  :is(.ty-sectioned-modal__nav, .ty-sectioned-modal__list) {
+    @media (max-width: 1023.98px) {
+      flex-direction: row;
+    }
+  }
+  .ty-sectioned-modal__group-name {
+    margin-block-end: var(--ty-space-1);
+    padding-inline: var(--ty-space-3);
+  }
+  :is(.ty-sectioned-modal__group-name, .ty-sectioned-modal__identity) {
+    @media (max-width: 1023.98px) {
+      display: none;
+    }
+  }
+  .ty-sectioned-modal__item {
+    position: relative;
+    display: flex;
+    align-items: center;
+    gap: var(--ty-space-2);
+    inline-size: 100%;
+    min-block-size: var(--ty-control-target);
+    padding: 0 var(--ty-space-3);
+    color: var(--ty-ink-2);
+    font: inherit;
+    text-align: start;
+    background: transparent;
+    border: 0;
+    border-radius: var(--ty-radius-control);
+    cursor: pointer;
+    outline: none;
+
+    &[data-hovered] {
+      background: var(--ty-surface);
+    }
+    &[data-focus-visible] {
+      outline: var(--ty-focus-width) solid var(--ty-focus-ring);
+      outline-offset: -2px;
+    }
+    &[data-active] {
+      color: var(--ty-accent);
+      font-weight: var(--ty-font-weight-semibold);
+      background: var(--ty-accent-soft);
+      box-shadow: var(--ty-smd-current);
+    }
+    @media (max-width: 1023.98px) {
+      white-space: nowrap;
+    }
+    @media (forced-colors: active) {
+      &[data-active] {
+        outline: 2px solid Highlight;
+        outline-offset: -2px;
+        box-shadow: none;
+      }
+    }
+  }
+  .ty-sectioned-modal__item-icon > svg {
+    inline-size: 18px;
+    block-size: 18px;
+  }
+  .ty-sectioned-modal__item-label {
+    flex: 1;
+  }
+  .ty-sectioned-modal__count {
+    color: var(--ty-ink-3);
+    font-family: var(--ty-font-mono);
+    font-size: var(--ty-font-size-meta);
+  }
+  .ty-sectioned-modal__rail-foot {
+    margin-block-start: auto;
+    padding-block-start: var(--ty-space-3);
+    border-block-start: 1px solid var(--ty-line);
+
+    @media (max-width: 1023.98px) {
+      margin: 0;
+      margin-inline-start: auto;
+      padding: 0;
+      border: 0;
+    }
+  }
+
+  /* Content and actions. */
+  .ty-sectioned-modal__body {
+    gap: var(--ty-space-4);
+    padding: var(--ty-space-6) var(--ty-smd-pad-x);
+    overflow-y: auto;
+  }
+  .ty-sectioned-modal__foot {
+    display: flex;
+    flex-wrap: wrap;
+    justify-content: flex-end;
+    gap: var(--ty-space-3);
+    padding-inline: var(--ty-smd-pad-x);
+    padding-block: var(--ty-space-4) calc(var(--ty-space-4) + env(safe-area-inset-bottom, 0px));
+    border-block-start: 1px solid var(--ty-line);
+  }
+
+  /* Phones: the panel fills the screen and the footer stays above the safe area. */
+  @media (max-width: 639.98px) {
+    .ty-sectioned-modal {
+      --ty-smd-pad-x: var(--ty-space-4);
+      --ty-smd-margin: 0px;
+      inline-size: 100%;
+      block-size: 100dvh;
+      max-block-size: 100dvh;
+      border-radius: 0;
+    }
+    .ty-sectioned-modal__backdrop {
+      padding: 0;
+    }
+    .ty-sectioned-modal__foot {
+      position: sticky;
+      inset-block-end: 0;
+      background: var(--ty-surface-raised);
+    }
+  }
+
+  @keyframes ty-smd-lift {
+    from {
+      opacity: 0;
+      translate: 0 12px;
+    }
+  }
+  @keyframes ty-smd-fade {
+    from {
+      opacity: 0;
+    }
+  }
+}

package/src/components/sectioned-modal/SectionedModal.test.tsx

@@ -0,0 +1,138 @@
+import { render, screen, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
+import { describe, expect, it, vi } from 'vitest'
+import { expectNoAxeViolations } from '../../../test/axe'
+import { cssOf, mediaBlock } from '../../../test/css'
+import { SectionedModal } from './SectionedModal'
+import * as rtlDom from '@testing-library/react'
+import { expectNoAxeViolations as axeRtl } from '../../../test/axe'
+import { renderRtl } from '../../../test/rtl'
+
+const sections = [
+  { id: 'a', label: 'General', content: <p>General content</p> },
+  { id: 'b', label: 'Modules', content: <p>Modules content</p>, count: 4 },
+  { id: 'c', label: 'Keys', content: <p>Keys content</p> },
+]
+
+describe('SectionedModal', () => {
+  it('exposes a dialog named by the title with focus inside', async () => {
+    render(
+      <SectionedModal open onClose={() => {}} title="Edit source" subtitle="Changes are saved to the draft.">
+        <label>
+          Name <input />
+        </label>
+      </SectionedModal>,
+    )
+    const dialog = screen.getByRole('dialog', { name: 'Edit source' })
+    expect(dialog).toHaveAccessibleDescription('Changes are saved to the draft.')
+    await waitFor(() => expect(screen.getByRole('textbox', { name: 'Name' })).toHaveFocus())
+  })
+
+  it('ignores Escape when not dismissible but closes from the close button', async () => {
+    const onClose = vi.fn()
+    render(<SectionedModal open onClose={onClose} title="Locked" dismissible={false} />)
+    await userEvent.keyboard('{Escape}')
+    expect(onClose).not.toHaveBeenCalled()
+    await userEvent.click(screen.getByRole('button', { name: 'Close' }))
+    expect(onClose).toHaveBeenCalledTimes(1)
+  })
+
+  it('submits on Ctrl+Enter but not on Enter inside a text area', async () => {
+    const onSubmit = vi.fn()
+    render(
+      <SectionedModal open onClose={() => {}} title="Note" onSubmit={onSubmit} formFooter={{}}>
+        <label>
+          Title <input />
+        </label>
+        <label>
+          Body <textarea />
+        </label>
+      </SectionedModal>,
+    )
+    await userEvent.click(screen.getByRole('textbox', { name: 'Body' }))
+    await userEvent.keyboard('{Enter}')
+    expect(onSubmit).not.toHaveBeenCalled()
+    await userEvent.click(screen.getByRole('textbox', { name: 'Title' }))
+    await userEvent.keyboard('{Control>}{Enter}{/Control}')
+    expect(onSubmit).toHaveBeenCalledTimes(1)
+  })
+
+  it('does not pull focus back to the first field after the person moved into the body', async () => {
+    const raf = vi.spyOn(window, 'requestAnimationFrame')
+    render(
+      <SectionedModal open onClose={() => {}} title="Note" onSubmit={() => {}} formFooter={{}}>
+        <label>
+          Title <input />
+        </label>
+        <label>
+          Body <textarea />
+        </label>
+      </SectionedModal>,
+    )
+    const body = screen.getByRole('textbox', { name: 'Body' })
+    body.focus()
+    // Run the pending initial-focus frame now, after the person's move.
+    for (const [cb] of raf.mock.calls) cb(performance.now())
+    raf.mockRestore()
+    expect(body).toHaveFocus()
+  })
+
+  it('shows Save busy and disabled while pending', () => {
+    render(<SectionedModal open onClose={() => {}} title="Note" onSubmit={() => {}} formFooter={{ pending: true }} />)
+    const save = screen.getByRole('button', { name: 'Save' })
+    expect(save).toHaveAttribute('aria-busy', 'true')
+    expect(save).toHaveAttribute('aria-disabled', 'true')
+    expect(screen.getByRole('button', { name: 'Cancel' })).toBeDisabled()
+  })
+
+  it('shows the error as an alert in the body', () => {
+    render(<SectionedModal open onClose={() => {}} title="Note" error="The server refused the change." />)
+    expect(screen.getByRole('alert')).toHaveTextContent('The server refused the change.')
+  })
+
+  it('switches sections and marks the current one', async () => {
+    render(<SectionedModal open onClose={() => {}} title="Settings" sections={sections} />)
+    expect(screen.getByText('General content')).toBeInTheDocument()
+    const nav = screen.getByRole('navigation', { name: 'Settings' })
+    await userEvent.click(screen.getByRole('button', { name: /Modules/ }))
+    expect(screen.getByText('Modules content')).toBeInTheDocument()
+    expect(screen.getByRole('button', { name: /Modules/ })).toHaveAttribute('aria-current', 'page')
+    expect(screen.getByRole('region', { name: 'Modules' })).toBeInTheDocument()
+    expect(nav).toBeInTheDocument()
+  })
+
+  it('starts on defaultSection', () => {
+    render(<SectionedModal open onClose={() => {}} title="Settings" sections={sections} defaultSection="b" />)
+    expect(screen.getByText('Modules content')).toBeInTheDocument()
+  })
+
+  it('names the bare layout with ariaLabel', () => {
+    render(
+      <SectionedModal open onClose={() => {}} ariaLabel="Preview">
+        <p>Only content</p>
+      </SectionedModal>,
+    )
+    expect(screen.getByRole('dialog', { name: 'Preview' })).toBeInTheDocument()
+  })
+
+  it('fills the screen under 640 with the footer pinned', () => {
+    const narrow = mediaBlock(cssOf('components/sectioned-modal/SectionedModal.css'), /\(max-width:\s*639\.98px\)/)
+    expect(narrow).toMatch(/block-size:\s*100dvh/)
+    expect(narrow).toMatch(/\.ty-sectioned-modal__foot\s*\{[^}]*position:\s*sticky/)
+  })
+
+  it('has no axe violations (sectioned form with error)', async () => {
+    render(
+      <SectionedModal open onClose={() => {}} title="Settings" eyebrow="Project" sections={sections} onSubmit={() => {}} formFooter={{}} error="Try again." />,
+    )
+    await expectNoAxeViolations(document.body)
+  })
+})
+
+describe('SectionedModal in right-to-left (ar)', () => {
+  it('renders mirrored where directional and passes axe', async () => {
+    renderRtl(<SectionedModal open onClose={() => {}} title="تحرير المصدر" size="md"><p>نص</p></SectionedModal>)
+    expect(await rtlDom.screen.findByRole('dialog', { name: /تحرير المصدر/ })).toBeInTheDocument()
+    await axeRtl(document.body)
+  })
+})