@eifi1/ui-kit 0.4.0 → 0.5.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.
- package/LICENSE +32 -0
- package/README.md +498 -57
- package/dist/chart.d.ts +10 -0
- package/dist/chart.js +10 -0
- package/dist/chart.js.map +1 -0
- package/dist/components/account-settings.d.ts +11 -0
- package/dist/components/account-settings.js +19 -12
- package/dist/components/account-settings.js.map +1 -1
- package/dist/components/alert-banner.d.ts +10 -6
- package/dist/components/alert-banner.js +20 -16
- package/dist/components/alert-banner.js.map +1 -1
- package/dist/components/amount-input.d.ts +30 -4
- package/dist/components/amount-input.js +36 -14
- package/dist/components/amount-input.js.map +1 -1
- package/dist/components/calculator.d.ts +24 -7
- package/dist/components/calculator.js +37 -20
- package/dist/components/calculator.js.map +1 -1
- package/dist/components/chart-zoom.d.ts +156 -0
- package/dist/components/chart-zoom.js +262 -0
- package/dist/components/chart-zoom.js.map +1 -0
- package/dist/components/chart.d.ts +28 -3
- package/dist/components/chart.js +71 -32
- package/dist/components/chart.js.map +1 -1
- package/dist/components/checkbox.d.ts +51 -0
- package/dist/components/checkbox.js +123 -0
- package/dist/components/checkbox.js.map +1 -0
- package/dist/components/chip.d.ts +128 -0
- package/dist/components/chip.js +357 -0
- package/dist/components/chip.js.map +1 -0
- package/dist/components/choice-parts.d.ts +24 -0
- package/dist/components/choice-parts.js +18 -0
- package/dist/components/choice-parts.js.map +1 -0
- package/dist/components/combobox-core.d.ts +52 -9
- package/dist/components/combobox-core.js +91 -20
- package/dist/components/combobox-core.js.map +1 -1
- package/dist/components/combobox.d.ts +43 -33
- package/dist/components/combobox.js +409 -340
- package/dist/components/combobox.js.map +1 -1
- package/dist/components/currency-select.d.ts +48 -8
- package/dist/components/currency-select.js +107 -65
- package/dist/components/currency-select.js.map +1 -1
- package/dist/components/data-table-filter-popover.d.ts +15 -3
- package/dist/components/data-table-filter-popover.js +23 -17
- package/dist/components/data-table-filter-popover.js.map +1 -1
- package/dist/components/data-table-filters.d.ts +1 -1
- package/dist/components/data-table-filters.js +3 -2
- package/dist/components/data-table-filters.js.map +1 -1
- package/dist/components/data-table-labels.d.ts +53 -2
- package/dist/components/data-table-labels.js +31 -2
- package/dist/components/data-table-labels.js.map +1 -1
- package/dist/components/data-table-pagination.d.ts +3 -1
- package/dist/components/data-table-pagination.js +16 -10
- package/dist/components/data-table-pagination.js.map +1 -1
- package/dist/components/data-table-sort.js +1 -0
- package/dist/components/data-table-sort.js.map +1 -1
- package/dist/components/data-table.d.ts +1 -1
- package/dist/components/data-table.js +201 -85
- package/dist/components/data-table.js.map +1 -1
- package/dist/components/date-picker.d.ts +25 -9
- package/dist/components/date-picker.js +232 -94
- package/dist/components/date-picker.js.map +1 -1
- package/dist/components/dropdown.d.ts +96 -20
- package/dist/components/dropdown.js +77 -33
- package/dist/components/dropdown.js.map +1 -1
- package/dist/components/entity-combobox.d.ts +5 -4
- package/dist/components/entity-combobox.js +107 -76
- package/dist/components/entity-combobox.js.map +1 -1
- package/dist/components/facing-pair.d.ts +36 -0
- package/dist/components/facing-pair.js +40 -0
- package/dist/components/facing-pair.js.map +1 -0
- package/dist/components/field-sync.d.ts +164 -0
- package/dist/components/field-sync.js +264 -0
- package/dist/components/field-sync.js.map +1 -0
- package/dist/components/file-dropzone.d.ts +38 -6
- package/dist/components/file-dropzone.js +34 -9
- package/dist/components/file-dropzone.js.map +1 -1
- package/dist/components/full-bleed-dialog.d.ts +37 -26
- package/dist/components/full-bleed-dialog.js +20 -5
- package/dist/components/full-bleed-dialog.js.map +1 -1
- package/dist/components/grouped-picker.d.ts +21 -10
- package/dist/components/grouped-picker.js +66 -52
- package/dist/components/grouped-picker.js.map +1 -1
- package/dist/components/hover-menu.d.ts +20 -4
- package/dist/components/hover-menu.js +15 -4
- package/dist/components/hover-menu.js.map +1 -1
- package/dist/components/mini-calendar.d.ts +102 -14
- package/dist/components/mini-calendar.js +256 -70
- package/dist/components/mini-calendar.js.map +1 -1
- package/dist/components/modal.d.ts +9 -3
- package/dist/components/modal.js +34 -45
- package/dist/components/modal.js.map +1 -1
- package/dist/components/month-picker.d.ts +79 -0
- package/dist/components/month-picker.js +342 -0
- package/dist/components/month-picker.js.map +1 -0
- package/dist/components/multi-entity-combobox.d.ts +7 -6
- package/dist/components/multi-entity-combobox.js +112 -72
- package/dist/components/multi-entity-combobox.js.map +1 -1
- package/dist/components/multi-select.d.ts +13 -11
- package/dist/components/multi-select.js +161 -84
- package/dist/components/multi-select.js.map +1 -1
- package/dist/components/number-field.d.ts +92 -0
- package/dist/components/number-field.js +111 -0
- package/dist/components/number-field.js.map +1 -0
- package/dist/components/number-input.d.ts +28 -2
- package/dist/components/number-input.js +12 -2
- package/dist/components/number-input.js.map +1 -1
- package/dist/components/numpad-sheet.d.ts +32 -4
- package/dist/components/numpad-sheet.js +30 -13
- package/dist/components/numpad-sheet.js.map +1 -1
- package/dist/components/page-contents.d.ts +90 -0
- package/dist/components/page-contents.js +170 -0
- package/dist/components/page-contents.js.map +1 -0
- package/dist/components/password-strength.d.ts +106 -0
- package/dist/components/password-strength.js +132 -0
- package/dist/components/password-strength.js.map +1 -0
- package/dist/components/picker-sheet.d.ts +23 -15
- package/dist/components/picker-sheet.js +34 -14
- package/dist/components/picker-sheet.js.map +1 -1
- package/dist/components/popover.d.ts +62 -4
- package/dist/components/popover.js +52 -2
- package/dist/components/popover.js.map +1 -1
- package/dist/components/search-field.d.ts +25 -7
- package/dist/components/search-field.js +7 -5
- package/dist/components/search-field.js.map +1 -1
- package/dist/components/series-chart-labels.d.ts +14 -0
- package/dist/components/series-chart-labels.js +11 -0
- package/dist/components/series-chart-labels.js.map +1 -0
- package/dist/components/series-chart.d.ts +207 -0
- package/dist/components/series-chart.js +223 -0
- package/dist/components/series-chart.js.map +1 -0
- package/dist/components/settings-fields.d.ts +14 -4
- package/dist/components/settings-fields.js +19 -8
- package/dist/components/settings-fields.js.map +1 -1
- package/dist/components/signature-pad.d.ts +119 -0
- package/dist/components/signature-pad.js +405 -0
- package/dist/components/signature-pad.js.map +1 -0
- package/dist/components/slider.d.ts +80 -0
- package/dist/components/slider.js +155 -0
- package/dist/components/slider.js.map +1 -0
- package/dist/components/sparkline.d.ts +93 -0
- package/dist/components/sparkline.js +205 -0
- package/dist/components/sparkline.js.map +1 -0
- package/dist/components/stat-tile.d.ts +151 -0
- package/dist/components/stat-tile.js +236 -0
- package/dist/components/stat-tile.js.map +1 -0
- package/dist/components/swipeable-row.d.ts +25 -2
- package/dist/components/swipeable-row.js +31 -0
- package/dist/components/swipeable-row.js.map +1 -1
- package/dist/components/switch.d.ts +60 -0
- package/dist/components/switch.js +81 -0
- package/dist/components/switch.js.map +1 -0
- package/dist/components/time-input.d.ts +58 -0
- package/dist/components/time-input.js +50 -0
- package/dist/components/time-input.js.map +1 -0
- package/dist/components/toggle-group.d.ts +18 -3
- package/dist/components/toggle-group.js +10 -6
- package/dist/components/toggle-group.js.map +1 -1
- package/dist/components/toggle-legend.d.ts +115 -0
- package/dist/components/toggle-legend.js +114 -0
- package/dist/components/toggle-legend.js.map +1 -0
- package/dist/components/tooltip.d.ts +40 -11
- package/dist/components/tooltip.js +77 -20
- package/dist/components/tooltip.js.map +1 -1
- package/dist/components/treemap.d.ts +132 -0
- package/dist/components/treemap.js +179 -0
- package/dist/components/treemap.js.map +1 -0
- package/dist/components/ui.d.ts +159 -46
- package/dist/components/ui.js +220 -115
- package/dist/components/ui.js.map +1 -1
- package/dist/components/use-mobile-reveal.js +1 -0
- package/dist/components/use-mobile-reveal.js.map +1 -1
- package/dist/components/use-table-state.d.ts +1 -1
- package/dist/components/use-table-state.js +38 -17
- package/dist/components/use-table-state.js.map +1 -1
- package/dist/components/user-avatar.d.ts +15 -4
- package/dist/components/user-avatar.js +5 -4
- package/dist/components/user-avatar.js.map +1 -1
- package/dist/components/wizard-stepper.js +3 -2
- package/dist/components/wizard-stepper.js.map +1 -1
- package/dist/{data-table-filters-aXyf0Xub.d.ts → data-table-filters-DM1auUfH.d.ts} +27 -5
- package/dist/data-table.d.ts +7 -0
- package/dist/data-table.js +12 -0
- package/dist/data-table.js.map +1 -0
- package/dist/feedback/feedback-attachment.js +12 -11
- package/dist/feedback/feedback-attachment.js.map +1 -1
- package/dist/feedback/feedback-dialog.js +2 -1
- package/dist/feedback/feedback-dialog.js.map +1 -1
- package/dist/feedback/feedback-inbox.d.ts +33 -7
- package/dist/feedback/feedback-inbox.js +49 -37
- package/dist/feedback/feedback-inbox.js.map +1 -1
- package/dist/feedback.d.ts +5 -0
- package/dist/feedback.js +5 -0
- package/dist/feedback.js.map +1 -0
- package/dist/hooks/use-anchored-panel.js +1 -0
- package/dist/hooks/use-anchored-panel.js.map +1 -1
- package/dist/hooks/use-anchored-rect.js +1 -0
- package/dist/hooks/use-anchored-rect.js.map +1 -1
- package/dist/hooks/use-announce.d.ts +46 -0
- package/dist/hooks/use-announce.js +37 -0
- package/dist/hooks/use-announce.js.map +1 -0
- package/dist/hooks/use-body-scroll-lock.js +1 -0
- package/dist/hooks/use-body-scroll-lock.js.map +1 -1
- package/dist/hooks/use-close-transition.js +1 -0
- package/dist/hooks/use-close-transition.js.map +1 -1
- package/dist/hooks/use-dismiss.js +1 -0
- package/dist/hooks/use-dismiss.js.map +1 -1
- package/dist/hooks/use-focus-trap.d.ts +16 -0
- package/dist/hooks/use-focus-trap.js +67 -0
- package/dist/hooks/use-focus-trap.js.map +1 -0
- package/dist/hooks/use-media-query.js +1 -0
- package/dist/hooks/use-media-query.js.map +1 -1
- package/dist/hooks/use-overlay-history.js +27 -1
- package/dist/hooks/use-overlay-history.js.map +1 -1
- package/dist/hooks/use-row-swipe.js +1 -0
- package/dist/hooks/use-row-swipe.js.map +1 -1
- package/dist/i18n/defaults.d.ts +31 -0
- package/dist/i18n/defaults.js +63 -0
- package/dist/i18n/defaults.js.map +1 -0
- package/dist/i18n/kit-labels.d.ts +250 -0
- package/dist/i18n/kit-labels.js +184 -0
- package/dist/i18n/kit-labels.js.map +1 -0
- package/dist/index.d.ts +47 -22
- package/dist/index.js +28 -0
- package/dist/index.js.map +1 -1
- package/dist/lib/calc.js +1 -0
- package/dist/lib/calc.js.map +1 -1
- package/dist/lib/cn.js +1 -0
- package/dist/lib/cn.js.map +1 -1
- package/dist/lib/dates.js +1 -0
- package/dist/lib/dates.js.map +1 -1
- package/dist/lib/logger.js +1 -0
- package/dist/lib/logger.js.map +1 -1
- package/dist/lib/safe-storage.js +1 -0
- package/dist/lib/safe-storage.js.map +1 -1
- package/dist/search/command-palette.d.ts +11 -1
- package/dist/search/command-palette.js +21 -15
- package/dist/search/command-palette.js.map +1 -1
- package/dist/search.d.ts +2 -0
- package/dist/search.js +3 -0
- package/dist/search.js.map +1 -0
- package/dist/shell/app-shell.d.ts +33 -4
- package/dist/shell/app-shell.js +275 -78
- package/dist/shell/app-shell.js.map +1 -1
- package/dist/shell/option-switcher-menu.js +3 -2
- package/dist/shell/option-switcher-menu.js.map +1 -1
- package/dist/shell/role-switcher.d.ts +6 -0
- package/dist/shell/role-switcher.js +7 -4
- package/dist/shell/role-switcher.js.map +1 -1
- package/dist/shell/top-bar.d.ts +15 -7
- package/dist/shell/top-bar.js +3 -5
- package/dist/shell/top-bar.js.map +1 -1
- package/dist/shell/topbar-action-menu.js +3 -2
- package/dist/shell/topbar-action-menu.js.map +1 -1
- package/dist/shell/topbar-controls.d.ts +5 -2
- package/dist/shell/topbar-controls.js +20 -15
- package/dist/shell/topbar-controls.js.map +1 -1
- package/dist/shell.d.ts +13 -0
- package/dist/shell.js +8 -0
- package/dist/shell.js.map +1 -0
- package/dist/theme/chart-palette.d.ts +19 -12
- package/dist/theme/chart-palette.js +24 -30
- package/dist/theme/chart-palette.js.map +1 -1
- package/dist/theme/color.d.ts +78 -0
- package/dist/theme/color.js +148 -0
- package/dist/theme/color.js.map +1 -0
- package/dist/theme/palette-derive.d.ts +140 -0
- package/dist/theme/palette-derive.js +376 -0
- package/dist/theme/palette-derive.js.map +1 -0
- package/dist/theme/palette-presets.d.ts +27 -5
- package/dist/theme/palette-presets.js +231 -33
- package/dist/theme/palette-presets.js.map +1 -1
- package/dist/theme/palette-store.js +1 -0
- package/dist/theme/palette-store.js.map +1 -1
- package/dist/theme/theme-store.js +1 -0
- package/dist/theme/theme-store.js.map +1 -1
- package/dist/tour/tour.d.ts +2 -1
- package/dist/tour/tour.js +15 -9
- package/dist/tour/tour.js.map +1 -1
- package/dist/tour.d.ts +2 -0
- package/dist/tour.js +3 -0
- package/dist/tour.js.map +1 -0
- package/dist/wizard/stepper-nav.js +10 -8
- package/dist/wizard/stepper-nav.js.map +1 -1
- package/dist/wizard/types.d.ts +18 -2
- package/dist/wizard/types.js +4 -1
- package/dist/wizard/types.js.map +1 -1
- package/dist/wizard/use-wizard.js +12 -4
- package/dist/wizard/use-wizard.js.map +1 -1
- package/dist/wizard/validation.js +1 -0
- package/dist/wizard/validation.js.map +1 -1
- package/dist/wizard/wizard-context.js +1 -0
- package/dist/wizard/wizard-context.js.map +1 -1
- package/dist/wizard/wizard-step.js +1 -0
- package/dist/wizard/wizard-step.js.map +1 -1
- package/dist/wizard/wizard-summary.js +5 -3
- package/dist/wizard/wizard-summary.js.map +1 -1
- package/dist/wizard.d.ts +8 -0
- package/dist/wizard.js +9 -0
- package/dist/wizard.js.map +1 -0
- package/package.json +67 -14
- package/src/chart.ts +22 -0
- package/src/components/account-settings.tsx +275 -0
- package/src/components/alert-banner.tsx +75 -0
- package/src/components/amount-input.tsx +471 -0
- package/src/components/calculator.tsx +252 -0
- package/src/components/chart-zoom.tsx +499 -0
- package/src/components/chart.tsx +363 -0
- package/src/components/checkbox.tsx +222 -0
- package/src/components/chip.tsx +570 -0
- package/src/components/choice-parts.ts +33 -0
- package/src/components/combobox-core.tsx +540 -0
- package/src/components/combobox.tsx +1026 -0
- package/src/components/currency-select.tsx +269 -0
- package/src/components/data-table-filter-popover.tsx +252 -0
- package/src/components/data-table-filters.ts +176 -0
- package/src/components/data-table-labels.ts +190 -0
- package/src/components/data-table-pagination.tsx +126 -0
- package/src/components/data-table-sort.ts +70 -0
- package/src/components/data-table.tsx +1740 -0
- package/src/components/date-picker.tsx +631 -0
- package/src/components/dropdown.tsx +341 -0
- package/src/components/entity-combobox.tsx +215 -0
- package/src/components/facing-pair.ts +86 -0
- package/src/components/field-sync.tsx +472 -0
- package/src/components/file-dropzone.tsx +181 -0
- package/src/components/full-bleed-dialog.tsx +179 -0
- package/src/components/grouped-picker.tsx +157 -0
- package/src/components/hover-menu.tsx +183 -0
- package/src/components/mini-calendar.tsx +554 -0
- package/src/components/modal.tsx +287 -0
- package/src/components/month-picker.tsx +549 -0
- package/src/components/multi-entity-combobox.tsx +226 -0
- package/src/components/multi-select.tsx +303 -0
- package/src/components/number-field.tsx +225 -0
- package/src/components/number-input.tsx +211 -0
- package/src/components/numpad-sheet.tsx +264 -0
- package/src/components/page-contents.tsx +289 -0
- package/src/components/password-strength.tsx +258 -0
- package/src/components/picker-sheet.tsx +251 -0
- package/src/components/popover.tsx +195 -0
- package/src/components/search-field.tsx +146 -0
- package/src/components/series-chart-labels.ts +26 -0
- package/src/components/series-chart.tsx +481 -0
- package/src/components/settings-fields.tsx +68 -0
- package/src/components/signature-pad.tsx +630 -0
- package/src/components/slider.tsx +313 -0
- package/src/components/sparkline.tsx +329 -0
- package/src/components/stat-tile.tsx +448 -0
- package/src/components/swipeable-row.tsx +271 -0
- package/src/components/switch.tsx +170 -0
- package/src/components/time-input.tsx +107 -0
- package/src/components/toggle-group.tsx +153 -0
- package/src/components/toggle-legend.tsx +229 -0
- package/src/components/tooltip.tsx +477 -0
- package/src/components/treemap.tsx +390 -0
- package/src/components/ui.tsx +1284 -0
- package/src/components/use-mobile-reveal.ts +54 -0
- package/src/components/use-table-state.ts +295 -0
- package/src/components/user-avatar.tsx +61 -0
- package/src/components/wizard-stepper.tsx +37 -0
- package/src/data-table.ts +19 -0
- package/src/feedback/feedback-attachment.tsx +246 -0
- package/src/feedback/feedback-dialog.tsx +209 -0
- package/src/feedback/feedback-inbox.tsx +615 -0
- package/src/feedback.ts +8 -0
- package/src/hooks/use-anchored-panel.ts +169 -0
- package/src/hooks/use-anchored-rect.ts +78 -0
- package/src/hooks/use-announce.ts +85 -0
- package/src/hooks/use-body-scroll-lock.ts +94 -0
- package/src/hooks/use-close-transition.ts +99 -0
- package/src/hooks/use-dismiss.ts +77 -0
- package/src/hooks/use-focus-trap.ts +160 -0
- package/src/hooks/use-media-query.ts +23 -0
- package/src/hooks/use-overlay-history.ts +345 -0
- package/src/hooks/use-row-swipe.ts +212 -0
- package/src/i18n/defaults.ts +68 -0
- package/src/i18n/kit-labels.tsx +447 -0
- package/src/index.ts +169 -0
- package/src/lib/calc.ts +309 -0
- package/src/lib/cn.ts +5 -0
- package/src/lib/dates.ts +187 -0
- package/src/lib/logger.ts +73 -0
- package/src/lib/safe-storage.ts +37 -0
- package/src/search/command-palette.tsx +342 -0
- package/src/search.ts +3 -0
- package/src/shell/app-shell.tsx +772 -0
- package/src/shell/option-switcher-menu.tsx +72 -0
- package/src/shell/role-switcher.tsx +46 -0
- package/src/shell/top-bar.tsx +39 -0
- package/src/shell/topbar-action-menu.tsx +91 -0
- package/src/shell/topbar-controls.tsx +229 -0
- package/src/shell.ts +10 -0
- package/src/theme/chart-palette.ts +145 -0
- package/src/theme/color.ts +266 -0
- package/src/theme/palette-derive.ts +681 -0
- package/src/theme/palette-presets.ts +760 -0
- package/src/theme/palette-store.ts +94 -0
- package/src/theme/theme-store.ts +145 -0
- package/src/tour/tour.tsx +586 -0
- package/src/tour.ts +3 -0
- package/src/vite-env.d.ts +26 -0
- package/src/wizard/stepper-nav.tsx +221 -0
- package/src/wizard/types.ts +178 -0
- package/src/wizard/use-wizard.ts +345 -0
- package/src/wizard/validation.ts +37 -0
- package/src/wizard/wizard-context.tsx +29 -0
- package/src/wizard/wizard-step.tsx +14 -0
- package/src/wizard/wizard-summary.tsx +69 -0
- package/src/wizard.ts +14 -0
- package/tokens.css +222 -20
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import { useLayoutEffect, useState } from "react";
|
|
2
|
+
import type { RefObject } from "react";
|
|
3
|
+
import { useAnchoredRect, type AnchorRect } from "./use-anchored-rect";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Vertical placement for a portalled, `position: fixed` panel anchored to a trigger.
|
|
7
|
+
*
|
|
8
|
+
* The problem it solves (feedback #135): on a phone, opening a picker focuses its
|
|
9
|
+
* search box, the on-screen keyboard slides up, and a panel pinned below a trigger in
|
|
10
|
+
* the lower half of the screen ends up entirely behind that keyboard — with nothing
|
|
11
|
+
* the user can do about it, because `position: fixed` does not scroll.
|
|
12
|
+
*
|
|
13
|
+
* The keyboard is invisible to the usual measurements: on Android Chrome the LAYOUT
|
|
14
|
+
* viewport (`window.innerHeight`, and the origin `getBoundingClientRect` and
|
|
15
|
+
* `position: fixed` are relative to) does not shrink when it opens. Only
|
|
16
|
+
* `visualViewport` reports the region actually on screen, so that is what this reads.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
/** The on-screen region, in layout-viewport coordinates. */
|
|
20
|
+
export interface ViewportBox {
|
|
21
|
+
top: number;
|
|
22
|
+
height: number;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function readViewport(): ViewportBox {
|
|
26
|
+
if (typeof window === "undefined") return { top: 0, height: 0 };
|
|
27
|
+
const vv = window.visualViewport;
|
|
28
|
+
// offsetTop, not 0: with the keyboard up the user can also pan the visual viewport
|
|
29
|
+
// within the layout viewport, which shifts where "visible" starts.
|
|
30
|
+
return vv ? { top: vv.offsetTop, height: vv.height } : { top: 0, height: window.innerHeight };
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export interface AnchoredPanelOptions {
|
|
34
|
+
/** Space between trigger and panel. */
|
|
35
|
+
gap?: number;
|
|
36
|
+
/** Space kept clear at the viewport edges. */
|
|
37
|
+
margin?: number;
|
|
38
|
+
/** The height the panel would like, when there is room. */
|
|
39
|
+
preferredHeight?: number;
|
|
40
|
+
/** Below this, the space under the trigger counts as unusable and a flip is considered. */
|
|
41
|
+
minHeight?: number;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export interface AnchoredPanel {
|
|
45
|
+
/** The trigger's rect, or null while closed/unmeasured. */
|
|
46
|
+
rect: AnchorRect | null;
|
|
47
|
+
/** Viewport-space `top` for the panel. */
|
|
48
|
+
top: number;
|
|
49
|
+
/** Cap that keeps the panel inside the VISIBLE viewport — apply as `maxHeight`. */
|
|
50
|
+
maxHeight: number;
|
|
51
|
+
/** Whether the panel was flipped above the trigger. */
|
|
52
|
+
above: boolean;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/** Absolute floor: below this a list is useless, so overflow the margin instead. */
|
|
56
|
+
const FLOOR = 96;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* The pure half of {@link useAnchoredPanel}: where a panel goes, given the trigger's
|
|
60
|
+
* rect and the region actually on screen.
|
|
61
|
+
*
|
|
62
|
+
* Prefers below the trigger — the conventional direction, and the one that keeps the
|
|
63
|
+
* trigger's own value visible. Flips above only when below cannot show a usable list
|
|
64
|
+
* AND above is roomier, so a panel never jumps sides for a few pixels' gain. The
|
|
65
|
+
* returned `maxHeight` is what makes the flip sufficient rather than merely different:
|
|
66
|
+
* without it a tall panel placed above just runs off the top instead of the bottom.
|
|
67
|
+
*
|
|
68
|
+
* Split out so the geometry is testable without a DOM and a fake keyboard — @hb/ui has
|
|
69
|
+
* no test runner of its own, so this is exercised from the consuming app.
|
|
70
|
+
*/
|
|
71
|
+
export function anchoredPanelPlacement(
|
|
72
|
+
rect: Pick<AnchorRect, "top" | "bottom">,
|
|
73
|
+
viewport: ViewportBox,
|
|
74
|
+
{ gap = 4, margin = 8, preferredHeight = 320, minHeight = 160 }: AnchoredPanelOptions = {},
|
|
75
|
+
): Omit<AnchoredPanel, "rect"> {
|
|
76
|
+
const viewTop = viewport.top + margin;
|
|
77
|
+
const viewBottom = viewport.top + viewport.height - margin;
|
|
78
|
+
const spaceBelow = viewBottom - (rect.bottom + gap);
|
|
79
|
+
const spaceAbove = rect.top - gap - viewTop;
|
|
80
|
+
const above = spaceBelow < minHeight && spaceAbove > spaceBelow;
|
|
81
|
+
const space = Math.max(FLOOR, above ? spaceAbove : spaceBelow);
|
|
82
|
+
const maxHeight = Math.min(preferredHeight, space);
|
|
83
|
+
return {
|
|
84
|
+
top: above ? Math.max(viewTop, rect.top - gap - maxHeight) : rect.bottom + gap,
|
|
85
|
+
maxHeight,
|
|
86
|
+
above,
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Where to put a panel anchored under `ref`, tracking the visible viewport.
|
|
92
|
+
*
|
|
93
|
+
* Callers own horizontal placement — the pickers align to the trigger's left edge, the
|
|
94
|
+
* popovers to its right — and must apply `maxHeight` with an internal `overflow-y`.
|
|
95
|
+
*/
|
|
96
|
+
/**
|
|
97
|
+
* The region actually on screen, tracked while `active` (Keksdose live #328).
|
|
98
|
+
*
|
|
99
|
+
* The same measurement {@link useAnchoredPanel} caps a dropdown with, for the callers
|
|
100
|
+
* that need the box itself rather than a placement: a FULL-SCREEN sheet cannot use
|
|
101
|
+
* `inset-0`, because on Android the on-screen keyboard shrinks only the VISUAL
|
|
102
|
+
* viewport — `inset-0` still spans the whole screen, so the bottom of the sheet, and
|
|
103
|
+
* the end of whatever list is scrolling inside it, live behind the keyboard where no
|
|
104
|
+
* gesture reaches them.
|
|
105
|
+
*
|
|
106
|
+
* Returns `null` where there is nothing to correct: no `visualViewport` (jsdom, SSR,
|
|
107
|
+
* older browsers) or no keyboard taking a bite out of it. A caller then keeps its
|
|
108
|
+
* static layout, which is right at every width where this does not apply — and is why
|
|
109
|
+
* the desktop and the test suite see exactly the markup they saw before.
|
|
110
|
+
*/
|
|
111
|
+
export function useVisualViewport(active: boolean): ViewportBox | null {
|
|
112
|
+
const [box, setBox] = useState<ViewportBox | null>(null);
|
|
113
|
+
|
|
114
|
+
useLayoutEffect(() => {
|
|
115
|
+
if (!active) return;
|
|
116
|
+
const update = () => {
|
|
117
|
+
const vv = typeof window === "undefined" ? undefined : window.visualViewport;
|
|
118
|
+
// The 1px slack is not superstition: `visualViewport.height` is fractional on a
|
|
119
|
+
// device-pixel-ratio that is not an integer (his phone reports 1.25), so a
|
|
120
|
+
// strict comparison would report a "keyboard" of 0.4px on every phone and pin
|
|
121
|
+
// a height where none was needed.
|
|
122
|
+
setBox(vv && vv.height < window.innerHeight - 1 ? { top: vv.offsetTop, height: vv.height } : null);
|
|
123
|
+
};
|
|
124
|
+
update();
|
|
125
|
+
const vv = window.visualViewport;
|
|
126
|
+
vv?.addEventListener("resize", update);
|
|
127
|
+
vv?.addEventListener("scroll", update);
|
|
128
|
+
window.addEventListener("resize", update);
|
|
129
|
+
return () => {
|
|
130
|
+
vv?.removeEventListener("resize", update);
|
|
131
|
+
vv?.removeEventListener("scroll", update);
|
|
132
|
+
window.removeEventListener("resize", update);
|
|
133
|
+
};
|
|
134
|
+
}, [active]);
|
|
135
|
+
|
|
136
|
+
return box;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
export function useAnchoredPanel<T extends HTMLElement>(
|
|
140
|
+
ref: RefObject<T | null>,
|
|
141
|
+
open: boolean,
|
|
142
|
+
options: AnchoredPanelOptions = {},
|
|
143
|
+
): AnchoredPanel {
|
|
144
|
+
const rect = useAnchoredRect(ref, open);
|
|
145
|
+
const [viewport, setViewport] = useState<ViewportBox>(readViewport);
|
|
146
|
+
|
|
147
|
+
useLayoutEffect(() => {
|
|
148
|
+
if (!open) return;
|
|
149
|
+
const update = () => setViewport(readViewport());
|
|
150
|
+
update();
|
|
151
|
+
const vv = window.visualViewport;
|
|
152
|
+
// The visualViewport events are the ones that fire when the keyboard opens;
|
|
153
|
+
// window.resize is the fallback for browsers without the API (and for a genuine
|
|
154
|
+
// window resize on desktop).
|
|
155
|
+
vv?.addEventListener("resize", update);
|
|
156
|
+
vv?.addEventListener("scroll", update);
|
|
157
|
+
window.addEventListener("resize", update);
|
|
158
|
+
return () => {
|
|
159
|
+
vv?.removeEventListener("resize", update);
|
|
160
|
+
vv?.removeEventListener("scroll", update);
|
|
161
|
+
window.removeEventListener("resize", update);
|
|
162
|
+
};
|
|
163
|
+
}, [open]);
|
|
164
|
+
|
|
165
|
+
if (!rect) {
|
|
166
|
+
return { rect: null, top: 0, maxHeight: options.preferredHeight ?? 320, above: false };
|
|
167
|
+
}
|
|
168
|
+
return { rect, ...anchoredPanelPlacement(rect, viewport, options) };
|
|
169
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { useLayoutEffect, useState } from "react";
|
|
2
|
+
import type { RefObject } from "react";
|
|
3
|
+
|
|
4
|
+
/** The subset of an element's viewport rect used for anchored positioning. */
|
|
5
|
+
export interface AnchorRect {
|
|
6
|
+
top: number;
|
|
7
|
+
left: number;
|
|
8
|
+
right: number;
|
|
9
|
+
bottom: number;
|
|
10
|
+
width: number;
|
|
11
|
+
height: number;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function sameRect(a: AnchorRect | null, b: AnchorRect | null): boolean {
|
|
15
|
+
if (a === b) return true;
|
|
16
|
+
if (!a || !b) return false;
|
|
17
|
+
return (
|
|
18
|
+
a.top === b.top &&
|
|
19
|
+
a.left === b.left &&
|
|
20
|
+
a.right === b.right &&
|
|
21
|
+
a.bottom === b.bottom &&
|
|
22
|
+
a.width === b.width &&
|
|
23
|
+
a.height === b.height
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Tracks an anchor element's viewport rect while `open`, re-measuring on scroll
|
|
29
|
+
* (capture phase, so nested scroll containers are caught too) and resize, and
|
|
30
|
+
* returning null when closed or unmeasured. Callers derive their own panel
|
|
31
|
+
* position from the rect — this hook owns only the measure + listener lifecycle
|
|
32
|
+
* that every portalled, position:fixed popover/flyout otherwise re-implements.
|
|
33
|
+
*
|
|
34
|
+
* Measured in a layout effect so the position is ready before paint (no flicker
|
|
35
|
+
* on open).
|
|
36
|
+
*/
|
|
37
|
+
export function useAnchoredRect<T extends HTMLElement>(
|
|
38
|
+
ref: RefObject<T | null>,
|
|
39
|
+
open: boolean,
|
|
40
|
+
): AnchorRect | null {
|
|
41
|
+
const [rect, setRect] = useState<AnchorRect | null>(null);
|
|
42
|
+
|
|
43
|
+
useLayoutEffect(() => {
|
|
44
|
+
if (!open) {
|
|
45
|
+
// eslint-disable-next-line react-hooks/set-state-in-effect -- reset when closed
|
|
46
|
+
setRect(null);
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
const measure = () => {
|
|
50
|
+
const r = ref.current?.getBoundingClientRect();
|
|
51
|
+
if (!r) return;
|
|
52
|
+
const next = {
|
|
53
|
+
top: r.top,
|
|
54
|
+
left: r.left,
|
|
55
|
+
right: r.right,
|
|
56
|
+
bottom: r.bottom,
|
|
57
|
+
width: r.width,
|
|
58
|
+
height: r.height,
|
|
59
|
+
};
|
|
60
|
+
// Only publish a rect that actually MOVED. Every measurement allocates a fresh
|
|
61
|
+
// object and React compares state by identity, so an unguarded `setRect` here
|
|
62
|
+
// re-rendered the anchored panel on every scroll and resize event whether or not
|
|
63
|
+
// the anchor had moved — and this listens on the capture phase, so that is every
|
|
64
|
+
// ancestor scroll container, roughly per frame through a momentum scroll.
|
|
65
|
+
// `tour.tsx` already does exactly this on the same problem.
|
|
66
|
+
setRect((prev) => (sameRect(prev, next) ? prev : next));
|
|
67
|
+
};
|
|
68
|
+
measure();
|
|
69
|
+
window.addEventListener("resize", measure);
|
|
70
|
+
window.addEventListener("scroll", measure, true);
|
|
71
|
+
return () => {
|
|
72
|
+
window.removeEventListener("resize", measure);
|
|
73
|
+
window.removeEventListener("scroll", measure, true);
|
|
74
|
+
};
|
|
75
|
+
}, [open, ref]);
|
|
76
|
+
|
|
77
|
+
return rect;
|
|
78
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { useCallback, useEffect, useRef, useState } from "react";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Announce a state change that produces no focus change.
|
|
5
|
+
*
|
|
6
|
+
* Sorting a column, applying a filter, moving to the next page: the rows under the
|
|
7
|
+
* cursor silently become different rows, and nothing tells a screen-reader user. There
|
|
8
|
+
* is no focus move to carry the news, because the control they activated is still the
|
|
9
|
+
* control they are on. A live region is the only channel.
|
|
10
|
+
*
|
|
11
|
+
* Two details that are the whole reason this is a hook rather than a `<div aria-live>`
|
|
12
|
+
* written inline at each call site:
|
|
13
|
+
*
|
|
14
|
+
* 1. **The region must already be in the DOM before the message arrives.** Screen
|
|
15
|
+
* readers subscribe to a live region when they encounter it; a region that mounts
|
|
16
|
+
* *with* its first message is usually missed entirely. So `regionProps` is spread
|
|
17
|
+
* onto an element that renders empty from the start and never unmounts.
|
|
18
|
+
* 2. **Re-announcing the same string must still speak.** Assistive tech diffs the
|
|
19
|
+
* region's content, so setting "12 results" when it already says "12 results" is a
|
|
20
|
+
* no-op — which is exactly the case that matters when a user re-applies a filter
|
|
21
|
+
* and needs confirmation that something happened. Clearing first and setting on the
|
|
22
|
+
* next tick forces a diff.
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
export interface AnnounceRegionProps {
|
|
26
|
+
role: "status" | "alert";
|
|
27
|
+
"aria-live": "polite" | "assertive";
|
|
28
|
+
"aria-atomic": true;
|
|
29
|
+
/** `sr-only-fixed` — visually hidden without inflating the document height. */
|
|
30
|
+
className: string;
|
|
31
|
+
children: string;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface UseAnnounceReturn {
|
|
35
|
+
/** Speak `message`. Passing the same string twice still speaks twice. */
|
|
36
|
+
announce: (message: string) => void;
|
|
37
|
+
/** Spread onto an element that is rendered unconditionally. */
|
|
38
|
+
regionProps: AnnounceRegionProps;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export interface UseAnnounceOptions {
|
|
42
|
+
/**
|
|
43
|
+
* `polite` (default) waits for a pause; `assertive` interrupts. Sorting and paging
|
|
44
|
+
* are polite — interrupting someone mid-sentence to tell them a table re-sorted is
|
|
45
|
+
* worse than telling them a moment later. Reserve assertive for failures.
|
|
46
|
+
*/
|
|
47
|
+
politeness?: "polite" | "assertive";
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function useAnnounce({ politeness = "polite" }: UseAnnounceOptions = {}): UseAnnounceReturn {
|
|
51
|
+
const [message, setMessage] = useState("");
|
|
52
|
+
const timerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
|
|
53
|
+
|
|
54
|
+
useEffect(
|
|
55
|
+
() => () => {
|
|
56
|
+
if (timerRef.current) clearTimeout(timerRef.current);
|
|
57
|
+
},
|
|
58
|
+
[],
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
const announce = useCallback((next: string) => {
|
|
62
|
+
if (timerRef.current) clearTimeout(timerRef.current);
|
|
63
|
+
// Clear, then set on a later tick. A 0ms timeout is enough: it puts the two
|
|
64
|
+
// mutations in separate frames, which is what makes the second one a diff.
|
|
65
|
+
setMessage("");
|
|
66
|
+
timerRef.current = setTimeout(() => setMessage(next), 50);
|
|
67
|
+
}, []);
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
announce,
|
|
71
|
+
regionProps: {
|
|
72
|
+
role: politeness === "assertive" ? "alert" : "status",
|
|
73
|
+
"aria-live": politeness,
|
|
74
|
+
// Read the whole region, not just the changed words — "Page 3 of 14" is a
|
|
75
|
+
// sentence, and an atomic=false region can announce a bare "3".
|
|
76
|
+
"aria-atomic": true,
|
|
77
|
+
// `sr-only-fixed`, not `sr-only`: this region is rendered by the KIT inside a
|
|
78
|
+
// consumer's component, so there is no wrapper we can require to be `relative`.
|
|
79
|
+
// Tailwind's `sr-only` is `position: absolute` and would extend the document
|
|
80
|
+
// height from wherever it landed — see the note on the class in tokens.css.
|
|
81
|
+
className: "sr-only-fixed",
|
|
82
|
+
children: message,
|
|
83
|
+
},
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { useEffect } from "react";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* How many locks are currently held, and what `body.style.overflow` was before the
|
|
5
|
+
* first of them. Module scope on purpose: the whole point is that the lockers do not
|
|
6
|
+
* know about each other, so the only place they can agree is here.
|
|
7
|
+
*
|
|
8
|
+
* This used to be per-locker — each one saved the previous value and restored it on
|
|
9
|
+
* cleanup — and five places in this package do that (Modal, PickerSheet,
|
|
10
|
+
* NumberPadSheet, and the DataTable's row dialog and settings panel). Save/restore
|
|
11
|
+
* composes only if the releases are strictly nested in reverse order of the
|
|
12
|
+
* acquisitions, and React runs unmount cleanups PARENT FIRST, which is the opposite
|
|
13
|
+
* of what the idiom needs.
|
|
14
|
+
*
|
|
15
|
+
* The gesture that broke it is an ordinary one: open the transaction dialog, tap the
|
|
16
|
+
* amount — the numpad sheet opens on focus, in a later commit, capturing the
|
|
17
|
+
* "hidden" the dialog had already set — then press Save. Both unmount together, the
|
|
18
|
+
* dialog restores "" first, the sheet then puts "hidden" back, and the page is left
|
|
19
|
+
* unscrollable with no overlay on screen. The only way out was a reload.
|
|
20
|
+
*
|
|
21
|
+
* A count has neither failure: the first acquire records the real previous value, the
|
|
22
|
+
* last release restores it, and the order in between does not matter.
|
|
23
|
+
*/
|
|
24
|
+
let lockCount = 0;
|
|
25
|
+
let previousOverflow = "";
|
|
26
|
+
let previousPaddingRight = "";
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* How much width the scrollbar of the DOCUMENT is currently taking.
|
|
30
|
+
*
|
|
31
|
+
* Zero on every platform with overlay scrollbars (macOS, most Linux, every phone) and
|
|
32
|
+
* zero whenever the page does not scroll; ~15px on Windows with classic ones. Read
|
|
33
|
+
* BEFORE `overflow: hidden` is applied, because applying it is what makes it vanish.
|
|
34
|
+
*/
|
|
35
|
+
function scrollbarWidth(): number {
|
|
36
|
+
return Math.max(0, window.innerWidth - document.documentElement.clientWidth);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
function acquire(): void {
|
|
40
|
+
if (lockCount === 0) {
|
|
41
|
+
// ⚠️ Hiding the document's overflow REMOVES its scrollbar, and on a platform where
|
|
42
|
+
// that scrollbar occupied layout space the page gets ~15px wider for as long as the
|
|
43
|
+
// dialog is open — then snaps back on close. Keksdose dev #561 from a 500px-wide
|
|
44
|
+
// desktop window: *"remove the scroll bar to stop horizontal resizing when opening
|
|
45
|
+
// edit tx and closing"*.
|
|
46
|
+
//
|
|
47
|
+
// Replacing the width we are about to take away is the standard fix and the narrow
|
|
48
|
+
// one. The alternatives both cost more than the bug: `scrollbar-gutter` on `html`
|
|
49
|
+
// shrinks the initial containing block, so every `position: fixed` overlay stops
|
|
50
|
+
// 15px short on each edge (measured, and documented in tokens.css), and moving the
|
|
51
|
+
// scroll container to `main` below `md` stops a phone's URL bar collapsing. This
|
|
52
|
+
// touches neither — only the element already being modified, only while locked.
|
|
53
|
+
//
|
|
54
|
+
// Note this fixes the DIALOG jump specifically. The separate page-to-page width
|
|
55
|
+
// change, where one route scrolls and the next does not, is the open decision
|
|
56
|
+
// recorded in tokens.css and is untouched here.
|
|
57
|
+
const gap = scrollbarWidth();
|
|
58
|
+
previousOverflow = document.body.style.overflow;
|
|
59
|
+
previousPaddingRight = document.body.style.paddingRight;
|
|
60
|
+
document.body.style.overflow = "hidden";
|
|
61
|
+
if (gap > 0) {
|
|
62
|
+
// Added to whatever the body already had rather than assigned, so a consumer
|
|
63
|
+
// that sets its own padding keeps it.
|
|
64
|
+
const existing = parseFloat(getComputedStyle(document.body).paddingRight) || 0;
|
|
65
|
+
document.body.style.paddingRight = `${existing + gap}px`;
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
lockCount += 1;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
function release(): void {
|
|
72
|
+
if (lockCount === 0) return;
|
|
73
|
+
lockCount -= 1;
|
|
74
|
+
if (lockCount === 0) {
|
|
75
|
+
document.body.style.overflow = previousOverflow;
|
|
76
|
+
document.body.style.paddingRight = previousPaddingRight;
|
|
77
|
+
previousOverflow = "";
|
|
78
|
+
previousPaddingRight = "";
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Lock background scrolling while `locked` is true, restoring the prior value once
|
|
84
|
+
* the LAST holder releases. Composable with every other caller of this hook — see
|
|
85
|
+
* the note above for why that has to be a property of the hook rather than of each
|
|
86
|
+
* caller's discipline.
|
|
87
|
+
*/
|
|
88
|
+
export function useBodyScrollLock(locked: boolean): void {
|
|
89
|
+
useEffect(() => {
|
|
90
|
+
if (!locked) return;
|
|
91
|
+
acquire();
|
|
92
|
+
return release;
|
|
93
|
+
}, [locked]);
|
|
94
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { useCallback, useEffect, useRef, useState } from "react";
|
|
2
|
+
|
|
3
|
+
/** How long the exit animation runs, in ms. Mirrors `.animate-sheet-out` in
|
|
4
|
+
* tokens.css — the sheet is the slower of the two, so it is what the unmount waits
|
|
5
|
+
* for. Exported so a test can advance a fake clock by the real number rather than
|
|
6
|
+
* by a copy of it. */
|
|
7
|
+
export const OVERLAY_EXIT_MS = 220;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* The state machine an exit animation needs, written once for every overlay in this
|
|
11
|
+
* package (Keksdose live #320 rework: *"Recognized the opening transition. Choose
|
|
12
|
+
* transition should be the same, only backwards"*).
|
|
13
|
+
*
|
|
14
|
+
* ## Why a hook and not a class on the panel
|
|
15
|
+
*
|
|
16
|
+
* An enter animation is free: the element mounts, the keyframes run. An exit is not —
|
|
17
|
+
* by the time the state says "closed" the element is already gone, so something has to
|
|
18
|
+
* hold it on screen for exactly as long as the animation lasts. That something cannot
|
|
19
|
+
* be the caller (every caller would need the same timer) and it cannot be the panel's
|
|
20
|
+
* markup. It is this: the overlay's own affordances call {@link requestClose} instead
|
|
21
|
+
* of `onClose`, render the `-out` classes while `closing` is true, and the real
|
|
22
|
+
* `onClose` — the one that unmounts them — fires when the animation has finished.
|
|
23
|
+
*
|
|
24
|
+
* ## What it deliberately does not do
|
|
25
|
+
*
|
|
26
|
+
* It does not intercept a close the CALLER decides on. A dialog that closes itself
|
|
27
|
+
* after a successful save sets its own state and unmounts, with no exit animation, and
|
|
28
|
+
* that is the right trade: making it otherwise would mean every overlay owning an
|
|
29
|
+
* `open` prop and every caller waiting on a callback to learn when its own state took
|
|
30
|
+
* effect. What is animated is what the user dismissed — the X, the backdrop, Escape,
|
|
31
|
+
* the Back gesture — which is the motion the row was about.
|
|
32
|
+
*
|
|
33
|
+
* ## Reduced motion
|
|
34
|
+
*
|
|
35
|
+
* Closes immediately, without the delay. A user who has asked for no motion must not
|
|
36
|
+
* be made to wait 220ms for an animation they are not being shown, and the `-out`
|
|
37
|
+
* classes are never applied, so tokens.css needs no reduced-motion rule for them.
|
|
38
|
+
*/
|
|
39
|
+
export function useCloseTransition(
|
|
40
|
+
onClose: () => void,
|
|
41
|
+
ms: number = OVERLAY_EXIT_MS,
|
|
42
|
+
): { closing: boolean; requestClose: () => void } {
|
|
43
|
+
const [closing, setClosing] = useState(false);
|
|
44
|
+
const timer = useRef<ReturnType<typeof setTimeout> | null>(null);
|
|
45
|
+
// Latest-ref rather than a dependency: callers pass inline arrows, so a dependency
|
|
46
|
+
// would hand every render a new `requestClose` — and this one is read once, by a
|
|
47
|
+
// timer that has already been scheduled. Assigned in an effect, never during render
|
|
48
|
+
// (`react-hooks/refs`), matching `use-long-press.ts` next door.
|
|
49
|
+
const latest = useRef(onClose);
|
|
50
|
+
useEffect(() => {
|
|
51
|
+
latest.current = onClose;
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
// One timer, ever. A second Escape while the panel is already leaving must not
|
|
55
|
+
// schedule a second unmount — two `onClose` calls is a caller's state machine being
|
|
56
|
+
// run twice, which is how a "close" ends up also discarding the row behind it.
|
|
57
|
+
useEffect(
|
|
58
|
+
() => () => {
|
|
59
|
+
if (timer.current) clearTimeout(timer.current);
|
|
60
|
+
},
|
|
61
|
+
[],
|
|
62
|
+
);
|
|
63
|
+
|
|
64
|
+
const requestClose = useCallback(() => {
|
|
65
|
+
if (timer.current) return;
|
|
66
|
+
// Read at close time, not at mount: the setting can change under a long-lived
|
|
67
|
+
// page, and `matchMedia` is absent in jsdom and in SSR — where "no animation" is
|
|
68
|
+
// also the only correct answer, since nothing is painting.
|
|
69
|
+
const reduced =
|
|
70
|
+
typeof window === "undefined" ||
|
|
71
|
+
typeof window.matchMedia !== "function" ||
|
|
72
|
+
window.matchMedia("(prefers-reduced-motion: reduce)").matches;
|
|
73
|
+
if (reduced || ms <= 0) {
|
|
74
|
+
latest.current();
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
setClosing(true);
|
|
78
|
+
timer.current = setTimeout(() => {
|
|
79
|
+
timer.current = null;
|
|
80
|
+
// ⚠️ Reset BEFORE handing control back — reported from a phone within the hour
|
|
81
|
+
// of the 0.4.52 deploy that first shipped this hook, against every table at once.
|
|
82
|
+
// A panel that returns `null` while closed is still MOUNTED — `FullBleedDialog`
|
|
83
|
+
// early-returns after its hooks, and DataTable renders it once and flips `open`
|
|
84
|
+
// — so this state outlives the panel it describes. Left true, the NEXT open
|
|
85
|
+
// rendered `animate-*-out` with `animation-fill-mode: forwards` on a sheet that
|
|
86
|
+
// had only just arrived: it lowered itself off the screen in 220ms and stayed
|
|
87
|
+
// there, invisible but still holding the backdrop's pointer events. Every table
|
|
88
|
+
// on every phone, first open fine and every one after it not, until a route
|
|
89
|
+
// change remounted the component.
|
|
90
|
+
//
|
|
91
|
+
// Batched with the `onClose` below, so a caller that unmounts on close still
|
|
92
|
+
// renders exactly once and nothing flashes.
|
|
93
|
+
setClosing(false);
|
|
94
|
+
latest.current();
|
|
95
|
+
}, ms);
|
|
96
|
+
}, [ms]);
|
|
97
|
+
|
|
98
|
+
return { closing, requestClose };
|
|
99
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { useEffect, useRef } from "react";
|
|
2
|
+
import type { RefObject } from "react";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Calls `handler` on an Escape keydown while `enabled`. A single document-level
|
|
6
|
+
* listener owns the "press Escape to dismiss" behaviour that popovers, flyouts
|
|
7
|
+
* and menus otherwise each re-implement. `handler` is read live at event time,
|
|
8
|
+
* so it need not be memoised and the listener only re-subscribes when `enabled`
|
|
9
|
+
* flips (typically the open/closed transition).
|
|
10
|
+
*/
|
|
11
|
+
export function useEscapeKey(handler: () => void, enabled = true): void {
|
|
12
|
+
const handlerRef = useRef(handler);
|
|
13
|
+
// Written in an effect, not during render, so it satisfies react-hooks/refs: a
|
|
14
|
+
// render that React starts and then discards — a transition, a Suspense retry —
|
|
15
|
+
// would otherwise leave this holding a handler from a tree that never committed,
|
|
16
|
+
// and the document listener below would go on to call it. Keydown events fire
|
|
17
|
+
// after the commit, so the ref is always current by the time one arrives.
|
|
18
|
+
useEffect(() => {
|
|
19
|
+
handlerRef.current = handler;
|
|
20
|
+
});
|
|
21
|
+
useEffect(() => {
|
|
22
|
+
if (!enabled) return;
|
|
23
|
+
const onKey = (e: KeyboardEvent) => {
|
|
24
|
+
if (e.key === "Escape") handlerRef.current();
|
|
25
|
+
};
|
|
26
|
+
document.addEventListener("keydown", onKey);
|
|
27
|
+
return () => document.removeEventListener("keydown", onKey);
|
|
28
|
+
}, [enabled]);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Calls `handler` on a press that lands outside every supplied element, while
|
|
33
|
+
* `enabled` — the outside-click-to-close half of the same dismissal story. Pass one
|
|
34
|
+
* ref or several (trigger + panel); a press inside any of them is ignored. Refs and
|
|
35
|
+
* `handler` are read live, so an inline `[triggerRef, panelRef]` array is fine and
|
|
36
|
+
* won't churn the listener.
|
|
37
|
+
*
|
|
38
|
+
* **`pointerdown`, not `mousedown`** — one event covering mouse, touch and pen.
|
|
39
|
+
* This listened for `mousedown` alone, which on a touch platform is a SYNTHESISED
|
|
40
|
+
* event: the browser emits it for most taps, which is why nothing obviously broke,
|
|
41
|
+
* but the synthesis is not guaranteed. A tap that begins a scroll, or one that lands
|
|
42
|
+
* on an element which preventDefaults the touch sequence, may never produce one — and
|
|
43
|
+
* on a phone-first PWA whose pickers, menus and flyouts all dismiss through this hook,
|
|
44
|
+
* inheriting that is worse than choosing it.
|
|
45
|
+
*
|
|
46
|
+
* The one behaviour this changes deliberately: a touch-drag that starts outside an
|
|
47
|
+
* open panel now dismisses it at touch-down, where before it did not dismiss at all
|
|
48
|
+
* (a drag synthesises no mousedown). That matches every other platform surface, and
|
|
49
|
+
* the anchored panels re-measure on scroll precisely because the page moves under
|
|
50
|
+
* them.
|
|
51
|
+
*/
|
|
52
|
+
export function useOutsideClick(
|
|
53
|
+
refs: RefObject<HTMLElement | null> | RefObject<HTMLElement | null>[],
|
|
54
|
+
handler: () => void,
|
|
55
|
+
enabled = true,
|
|
56
|
+
): void {
|
|
57
|
+
const refsRef = useRef(refs);
|
|
58
|
+
const handlerRef = useRef(handler);
|
|
59
|
+
// In an effect rather than during render — see the note on useEscapeKey.
|
|
60
|
+
useEffect(() => {
|
|
61
|
+
refsRef.current = refs;
|
|
62
|
+
handlerRef.current = handler;
|
|
63
|
+
});
|
|
64
|
+
useEffect(() => {
|
|
65
|
+
if (!enabled) return;
|
|
66
|
+
const onPointerDown = (e: Event) => {
|
|
67
|
+
const target = e.target as Node;
|
|
68
|
+
const list = Array.isArray(refsRef.current) ? refsRef.current : [refsRef.current];
|
|
69
|
+
for (const r of list) {
|
|
70
|
+
if (r.current?.contains(target)) return;
|
|
71
|
+
}
|
|
72
|
+
handlerRef.current();
|
|
73
|
+
};
|
|
74
|
+
document.addEventListener("pointerdown", onPointerDown);
|
|
75
|
+
return () => document.removeEventListener("pointerdown", onPointerDown);
|
|
76
|
+
}, [enabled]);
|
|
77
|
+
}
|