@viewkitjs/views 0.0.0-stage → 0.2.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/CHANGELOG.md +615 -0
- package/LICENSE.md +7 -0
- package/README.md +99 -2
- package/dist/atoms/CommandMenu.d.ts +2 -0
- package/dist/atoms/CommandMenu.js +20 -0
- package/dist/atoms/List.d.ts +2 -0
- package/dist/atoms/List.js +6 -0
- package/dist/atoms/LoadMore.d.ts +2 -0
- package/dist/atoms/LoadMore.js +25 -0
- package/dist/atoms/Loading.d.ts +2 -0
- package/dist/atoms/Loading.js +7 -0
- package/dist/atoms/PlatformMark.d.ts +2 -0
- package/dist/atoms/PlatformMark.js +4 -0
- package/dist/atoms/RelationLink.d.ts +2 -0
- package/dist/atoms/RelationLink.js +6 -0
- package/dist/atoms/Row.d.ts +3 -0
- package/dist/atoms/Row.js +30 -0
- package/dist/atoms/RowMenu.d.ts +2 -0
- package/dist/atoms/RowMenu.js +112 -0
- package/dist/atoms/StatusBadge.d.ts +2 -0
- package/dist/atoms/StatusBadge.js +7 -0
- package/dist/atoms/StatusMarker.d.ts +2 -0
- package/dist/atoms/StatusMarker.js +19 -0
- package/dist/atoms/Tag.d.ts +2 -0
- package/dist/atoms/Tag.js +13 -0
- package/dist/atoms/TickBox.d.ts +2 -0
- package/dist/atoms/TickBox.js +8 -0
- package/dist/atoms/defaults.d.ts +2 -0
- package/dist/atoms/defaults.js +27 -0
- package/dist/atoms/tones.d.ts +5 -0
- package/dist/atoms/tones.js +28 -0
- package/dist/atoms/types.d.ts +178 -0
- package/dist/atoms/types.js +3 -0
- package/dist/cells/cell-format.d.ts +138 -0
- package/dist/cells/cell-format.js +16 -0
- package/dist/cells/cell-title.d.ts +17 -0
- package/dist/cells/cell-title.js +8 -0
- package/dist/cells/cell-values.d.ts +28 -0
- package/dist/cells/cell-values.js +87 -0
- package/dist/cells/index.d.ts +4 -0
- package/dist/cells/index.js +4 -0
- package/dist/cells/legacy-field.d.ts +52 -0
- package/dist/cells/legacy-field.js +164 -0
- package/dist/cells/relation-wrap.d.ts +3 -0
- package/dist/cells/relation-wrap.js +24 -0
- package/dist/cells/use-cell-format.d.ts +5 -0
- package/dist/cells/use-cell-format.js +10 -0
- package/dist/contract.d.ts +461 -0
- package/dist/contract.js +682 -0
- package/dist/display/actor.d.ts +4 -0
- package/dist/display/actor.js +26 -0
- package/dist/display/boolean.d.ts +18 -0
- package/dist/display/boolean.js +43 -0
- package/dist/display/breakdown.d.ts +15 -0
- package/dist/display/breakdown.js +32 -0
- package/dist/display/currency.d.ts +9 -0
- package/dist/display/currency.js +29 -0
- package/dist/display/date.d.ts +12 -0
- package/dist/display/date.js +26 -0
- package/dist/display/display-cores.d.ts +31 -0
- package/dist/display/display-cores.js +57 -0
- package/dist/display/entity-chip.d.ts +26 -0
- package/dist/display/entity-chip.js +9 -0
- package/dist/display/format.d.ts +66 -0
- package/dist/display/format.js +190 -0
- package/dist/display/index.d.ts +8 -0
- package/dist/display/index.js +7 -0
- package/dist/display/link.d.ts +29 -0
- package/dist/display/link.js +50 -0
- package/dist/display/location.d.ts +8 -0
- package/dist/display/location.js +22 -0
- package/dist/display/multi-value.d.ts +18 -0
- package/dist/display/multi-value.js +28 -0
- package/dist/display/name.d.ts +6 -0
- package/dist/display/name.js +14 -0
- package/dist/display/number.d.ts +11 -0
- package/dist/display/number.js +27 -0
- package/dist/display/options.d.ts +153 -0
- package/dist/display/options.js +1 -0
- package/dist/display/percent.d.ts +4 -0
- package/dist/display/percent.js +40 -0
- package/dist/display/phone.d.ts +11 -0
- package/dist/display/phone.js +45 -0
- package/dist/display/range.d.ts +6 -0
- package/dist/display/range.js +29 -0
- package/dist/display/relation.d.ts +4 -0
- package/dist/display/relation.js +29 -0
- package/dist/display/rich-text.d.ts +10 -0
- package/dist/display/rich-text.js +34 -0
- package/dist/display/select.d.ts +6 -0
- package/dist/display/select.js +38 -0
- package/dist/display/text-class.d.ts +23 -0
- package/dist/display/text-class.js +5 -0
- package/dist/display/text.d.ts +19 -0
- package/dist/display/text.js +8 -0
- package/dist/display/use-display-options.d.ts +2 -0
- package/dist/display/use-display-options.js +14 -0
- package/dist/display/user.d.ts +11 -0
- package/dist/display/user.js +10 -0
- package/dist/display/value-list.d.ts +10 -0
- package/dist/display/value-list.js +12 -0
- package/dist/display/viewer.d.ts +4 -0
- package/dist/display/viewer.js +11 -0
- package/dist/display/web-href.d.ts +8 -0
- package/dist/display/web-href.js +12 -0
- package/dist/editors/ChipsEditor.d.ts +59 -0
- package/dist/editors/ChipsEditor.js +73 -0
- package/dist/editors/DateEditor.d.ts +25 -0
- package/dist/editors/DateEditor.js +122 -0
- package/dist/editors/LocationEditor.d.ts +22 -0
- package/dist/editors/LocationEditor.js +228 -0
- package/dist/editors/NameEditor.d.ts +22 -0
- package/dist/editors/NameEditor.js +92 -0
- package/dist/editors/NumberEditor.d.ts +67 -0
- package/dist/editors/NumberEditor.js +86 -0
- package/dist/editors/RangeEditor.d.ts +22 -0
- package/dist/editors/RangeEditor.js +70 -0
- package/dist/editors/RelationEditor.d.ts +65 -0
- package/dist/editors/RelationEditor.js +64 -0
- package/dist/editors/SelectEditor.d.ts +72 -0
- package/dist/editors/SelectEditor.js +59 -0
- package/dist/editors/ValueListEditor.d.ts +38 -0
- package/dist/editors/ValueListEditor.js +217 -0
- package/dist/editors/edit-cores.d.ts +83 -0
- package/dist/editors/edit-cores.js +38 -0
- package/dist/editors/edit-session.d.ts +74 -0
- package/dist/editors/edit-session.js +35 -0
- package/dist/editors/open-values.d.ts +28 -0
- package/dist/editors/open-values.js +26 -0
- package/dist/editors/relation-source.d.ts +66 -0
- package/dist/editors/relation-source.js +102 -0
- package/dist/fields/binding.d.ts +87 -0
- package/dist/fields/binding.js +117 -0
- package/dist/fields/currency.d.ts +82 -0
- package/dist/fields/currency.js +41 -0
- package/dist/fields/denomination.d.ts +42 -0
- package/dist/fields/denomination.js +11 -0
- package/dist/fields/edit-core-types.d.ts +40 -0
- package/dist/fields/edit-core-types.js +29 -0
- package/dist/fields/format-knobs.d.ts +34 -0
- package/dist/fields/format-knobs.js +36 -0
- package/dist/fields/menus.d.ts +28 -0
- package/dist/fields/menus.js +1 -0
- package/dist/fields/money.d.ts +60 -0
- package/dist/fields/money.js +78 -0
- package/dist/fields/number-edit.d.ts +11 -0
- package/dist/fields/number-edit.js +17 -0
- package/dist/fields/prepare-write.d.ts +55 -0
- package/dist/fields/prepare-write.js +67 -0
- package/dist/fields/relation-source-types.d.ts +54 -0
- package/dist/fields/relation-source-types.js +1 -0
- package/dist/figures.d.ts +52 -0
- package/dist/figures.js +63 -0
- package/dist/filters/date-filter.d.ts +2 -0
- package/dist/filters/date-filter.js +1 -0
- package/dist/filters/filter-model.d.ts +176 -0
- package/dist/filters/filter-model.js +41 -0
- package/dist/filters/number-filter.d.ts +2 -0
- package/dist/filters/number-filter.js +1 -0
- package/dist/filters/range-filter.d.ts +2 -0
- package/dist/filters/range-filter.js +1 -0
- package/dist/filters/registry.d.ts +103 -0
- package/dist/filters/registry.js +8 -0
- package/dist/filters/relation-filter.d.ts +16 -0
- package/dist/filters/relation-filter.js +53 -0
- package/dist/filters/text-filter.d.ts +2 -0
- package/dist/filters/text-filter.js +1 -0
- package/dist/grid/chrome/GridAddColumn.d.ts +11 -0
- package/dist/grid/chrome/GridAddColumn.js +29 -0
- package/dist/grid/chrome/GridAggregateMenu.d.ts +31 -0
- package/dist/grid/chrome/GridAggregateMenu.js +27 -0
- package/dist/grid/chrome/GridCellEditors.d.ts +64 -0
- package/dist/grid/chrome/GridCellEditors.js +55 -0
- package/dist/grid/chrome/GridCellOutline.d.ts +70 -0
- package/dist/grid/chrome/GridCellOutline.js +21 -0
- package/dist/grid/chrome/GridChipsEditor.d.ts +28 -0
- package/dist/grid/chrome/GridChipsEditor.js +40 -0
- package/dist/grid/chrome/GridColumnColorSection.d.ts +11 -0
- package/dist/grid/chrome/GridColumnColorSection.js +40 -0
- package/dist/grid/chrome/GridColumnDateSection.d.ts +23 -0
- package/dist/grid/chrome/GridColumnDateSection.js +23 -0
- package/dist/grid/chrome/GridColumnDurationSection.d.ts +19 -0
- package/dist/grid/chrome/GridColumnDurationSection.js +24 -0
- package/dist/grid/chrome/GridColumnMenu.d.ts +101 -0
- package/dist/grid/chrome/GridColumnMenu.js +99 -0
- package/dist/grid/chrome/GridColumnNumberSection.d.ts +25 -0
- package/dist/grid/chrome/GridColumnNumberSection.js +27 -0
- package/dist/grid/chrome/GridColumnPercentSection.d.ts +15 -0
- package/dist/grid/chrome/GridColumnPercentSection.js +16 -0
- package/dist/grid/chrome/GridColumnSortSection.d.ts +18 -0
- package/dist/grid/chrome/GridColumnSortSection.js +16 -0
- package/dist/grid/chrome/GridDateEditor.d.ts +22 -0
- package/dist/grid/chrome/GridDateEditor.js +31 -0
- package/dist/grid/chrome/GridFlyout.d.ts +44 -0
- package/dist/grid/chrome/GridFlyout.js +80 -0
- package/dist/grid/chrome/GridFooter.d.ts +23 -0
- package/dist/grid/chrome/GridFooter.js +81 -0
- package/dist/grid/chrome/GridGroupMenu.d.ts +37 -0
- package/dist/grid/chrome/GridGroupMenu.js +57 -0
- package/dist/grid/chrome/GridHeader.d.ts +61 -0
- package/dist/grid/chrome/GridHeader.js +37 -0
- package/dist/grid/chrome/GridLongTextEditor.d.ts +36 -0
- package/dist/grid/chrome/GridLongTextEditor.js +127 -0
- package/dist/grid/chrome/GridMenuRow.d.ts +15 -0
- package/dist/grid/chrome/GridMenuRow.js +15 -0
- package/dist/grid/chrome/GridNameEditor.d.ts +19 -0
- package/dist/grid/chrome/GridNameEditor.js +36 -0
- package/dist/grid/chrome/GridNumberEditor.d.ts +35 -0
- package/dist/grid/chrome/GridNumberEditor.js +25 -0
- package/dist/grid/chrome/GridRangeEditor.d.ts +20 -0
- package/dist/grid/chrome/GridRangeEditor.js +25 -0
- package/dist/grid/chrome/GridRelationEditor.d.ts +21 -0
- package/dist/grid/chrome/GridRelationEditor.js +30 -0
- package/dist/grid/chrome/GridResizeHandle.d.ts +19 -0
- package/dist/grid/chrome/GridResizeHandle.js +19 -0
- package/dist/grid/chrome/GridRow.d.ts +25 -0
- package/dist/grid/chrome/GridRow.js +136 -0
- package/dist/grid/chrome/GridRowActions.d.ts +32 -0
- package/dist/grid/chrome/GridRowActions.js +25 -0
- package/dist/grid/chrome/GridRowCells.d.ts +4 -0
- package/dist/grid/chrome/GridRowCells.js +133 -0
- package/dist/grid/chrome/GridRowGlyph.d.ts +12 -0
- package/dist/grid/chrome/GridRowGlyph.js +13 -0
- package/dist/grid/chrome/GridSelectEditor.d.ts +18 -0
- package/dist/grid/chrome/GridSelectEditor.js +49 -0
- package/dist/grid/chrome/GridStructure.d.ts +48 -0
- package/dist/grid/chrome/GridStructure.js +45 -0
- package/dist/grid/chrome/GridTable.d.ts +4 -0
- package/dist/grid/chrome/GridTable.js +125 -0
- package/dist/grid/chrome/GridTableSurface.d.ts +15 -0
- package/dist/grid/chrome/GridTableSurface.js +6 -0
- package/dist/grid/chrome/GridTextEditor.d.ts +11 -0
- package/dist/grid/chrome/GridTextEditor.js +40 -0
- package/dist/grid/chrome/GridValueListEditor.d.ts +18 -0
- package/dist/grid/chrome/GridValueListEditor.js +36 -0
- package/dist/grid/chrome/StuckMarker.d.ts +16 -0
- package/dist/grid/chrome/StuckMarker.js +34 -0
- package/dist/grid/chrome/cell-clipboard.d.ts +9 -0
- package/dist/grid/chrome/cell-clipboard.js +28 -0
- package/dist/grid/chrome/cells.d.ts +21 -0
- package/dist/grid/chrome/cells.js +20 -0
- package/dist/grid/chrome/checks.d.ts +35 -0
- package/dist/grid/chrome/checks.js +22 -0
- package/dist/grid/chrome/column-glyph.d.ts +14 -0
- package/dist/grid/chrome/column-glyph.js +44 -0
- package/dist/grid/chrome/editors.d.ts +9 -0
- package/dist/grid/chrome/editors.js +10 -0
- package/dist/grid/chrome/grid-cell-classes.d.ts +59 -0
- package/dist/grid/chrome/grid-cell-classes.js +30 -0
- package/dist/grid/chrome/grid-menu-search.d.ts +7 -0
- package/dist/grid/chrome/grid-menu-search.js +7 -0
- package/dist/grid/chrome/grid-row-props.d.ts +131 -0
- package/dist/grid/chrome/grid-row-props.js +1 -0
- package/dist/grid/chrome/grid-styles.d.ts +37 -0
- package/dist/grid/chrome/grid-styles.js +8 -0
- package/dist/grid/chrome/grid-table-props.d.ts +173 -0
- package/dist/grid/chrome/grid-table-props.js +1 -0
- package/dist/grid/chrome/useGridBatchApi.d.ts +34 -0
- package/dist/grid/chrome/useGridBatchApi.js +35 -0
- package/dist/grid/chrome/useGridColumnLayout.d.ts +30 -0
- package/dist/grid/chrome/useGridColumnLayout.js +206 -0
- package/dist/grid/chrome/useGridHeaderDrag.d.ts +20 -0
- package/dist/grid/chrome/useGridHeaderDrag.js +37 -0
- package/dist/grid/chrome/useGridKeyboard.d.ts +47 -0
- package/dist/grid/chrome/useGridKeyboard.js +274 -0
- package/dist/grid/chrome/useGridPendingReconciliation.d.ts +12 -0
- package/dist/grid/chrome/useGridPendingReconciliation.js +32 -0
- package/dist/grid/chrome/useGridRailReveal.d.ts +57 -0
- package/dist/grid/chrome/useGridRailReveal.js +67 -0
- package/dist/grid/chrome/useGridRangeActions.d.ts +49 -0
- package/dist/grid/chrome/useGridRangeActions.js +188 -0
- package/dist/grid/chrome/useGridRangeGestures.d.ts +32 -0
- package/dist/grid/chrome/useGridRangeGestures.js +190 -0
- package/dist/grid/chrome/useGridRowContextMenu.d.ts +35 -0
- package/dist/grid/chrome/useGridRowContextMenu.js +127 -0
- package/dist/grid/chrome/useGridScaleStyles.d.ts +1 -0
- package/dist/grid/chrome/useGridScaleStyles.js +29 -0
- package/dist/grid/chrome/useGridScrollSync.d.ts +38 -0
- package/dist/grid/chrome/useGridScrollSync.js +176 -0
- package/dist/grid/chrome/useGridTableInteractionModel.d.ts +55 -0
- package/dist/grid/chrome/useGridTableInteractionModel.js +197 -0
- package/dist/grid/chrome/useGridTableSelection.d.ts +29 -0
- package/dist/grid/chrome/useGridTableSelection.js +55 -0
- package/dist/grid/chrome/useHeaderDragReorder.d.ts +21 -0
- package/dist/grid/chrome/useHeaderDragReorder.js +216 -0
- package/dist/grid/core/clipboard-model.d.ts +81 -0
- package/dist/grid/core/clipboard-model.js +291 -0
- package/dist/grid/core/column-values.d.ts +27 -0
- package/dist/grid/core/column-values.js +76 -0
- package/dist/grid/core/commit-model.d.ts +34 -0
- package/dist/grid/core/commit-model.js +3 -0
- package/dist/grid/core/coordinates.d.ts +48 -0
- package/dist/grid/core/coordinates.js +27 -0
- package/dist/grid/core/edit-values.d.ts +9 -0
- package/dist/grid/core/edit-values.js +1 -0
- package/dist/grid/core/editing-controller.d.ts +59 -0
- package/dist/grid/core/editing-controller.js +240 -0
- package/dist/grid/core/editing-model.d.ts +78 -0
- package/dist/grid/core/editing-model.js +136 -0
- package/dist/grid/core/grid-scale.d.ts +14 -0
- package/dist/grid/core/grid-scale.js +8 -0
- package/dist/grid/core/nav.d.ts +94 -0
- package/dist/grid/core/nav.js +92 -0
- package/dist/grid/core/pending-reconciliation.d.ts +50 -0
- package/dist/grid/core/pending-reconciliation.js +49 -0
- package/dist/grid/core/range-model.d.ts +25 -0
- package/dist/grid/core/range-model.js +59 -0
- package/dist/grid/core/spreadsheet-operations.d.ts +85 -0
- package/dist/grid/core/spreadsheet-operations.js +253 -0
- package/dist/grid/core/useGridEditing.d.ts +43 -0
- package/dist/grid/core/useGridEditing.js +90 -0
- package/dist/grid/core/useGridRange.d.ts +20 -0
- package/dist/grid/core/useGridRange.js +24 -0
- package/dist/grid/core/value-equality.d.ts +32 -0
- package/dist/grid/core/value-equality.js +34 -0
- package/dist/grid/index.d.ts +18 -0
- package/dist/grid/index.js +5 -0
- package/dist/grid/useGridTablePrefs.d.ts +50 -0
- package/dist/grid/useGridTablePrefs.js +101 -0
- package/dist/grouping/sort-groups.d.ts +18 -0
- package/dist/grouping/sort-groups.js +33 -0
- package/dist/grouping/types.d.ts +10 -0
- package/dist/grouping/types.js +1 -0
- package/dist/index.d.ts +28 -0
- package/dist/index.js +28 -0
- package/dist/internal/chip.d.ts +4 -0
- package/dist/internal/chip.js +3 -0
- package/dist/internal/cx.d.ts +3 -0
- package/dist/internal/cx.js +3 -0
- package/dist/internal/viewport.d.ts +5 -0
- package/dist/internal/viewport.js +29 -0
- package/dist/model/aggregates.d.ts +59 -0
- package/dist/model/aggregates.js +186 -0
- package/dist/model/card-density.d.ts +8 -0
- package/dist/model/card-density.js +10 -0
- package/dist/model/card-layout.d.ts +85 -0
- package/dist/model/card-layout.js +90 -0
- package/dist/model/column-capabilities.d.ts +162 -0
- package/dist/model/column-capabilities.js +233 -0
- package/dist/model/column-filters.d.ts +106 -0
- package/dist/model/column-filters.js +321 -0
- package/dist/model/column-format.d.ts +103 -0
- package/dist/model/column-format.js +1 -0
- package/dist/model/column-from.d.ts +28 -0
- package/dist/model/column-from.js +160 -0
- package/dist/model/column-inspect.d.ts +18 -0
- package/dist/model/column-inspect.js +6 -0
- package/dist/model/column-knobs.d.ts +20 -0
- package/dist/model/column-knobs.js +16 -0
- package/dist/model/column-money.d.ts +13 -0
- package/dist/model/column-money.js +27 -0
- package/dist/model/column-order.d.ts +36 -0
- package/dist/model/column-order.js +68 -0
- package/dist/model/column-schema.d.ts +335 -0
- package/dist/model/column-schema.js +1 -0
- package/dist/model/column-sort.d.ts +17 -0
- package/dist/model/column-sort.js +11 -0
- package/dist/model/column-state.d.ts +77 -0
- package/dist/model/column-state.js +95 -0
- package/dist/model/column-types.d.ts +109 -0
- package/dist/model/column-types.js +50 -0
- package/dist/model/column-warnings.d.ts +44 -0
- package/dist/model/column-warnings.js +24 -0
- package/dist/model/density.d.ts +3 -0
- package/dist/model/density.js +13 -0
- package/dist/model/field-type-of.d.ts +21 -0
- package/dist/model/field-type-of.js +11 -0
- package/dist/model/filter-capabilities.d.ts +1 -0
- package/dist/model/filter-capabilities.js +1 -0
- package/dist/model/index.d.ts +38 -0
- package/dist/model/index.js +20 -0
- package/dist/model/part-rows.d.ts +28 -0
- package/dist/model/part-rows.js +40 -0
- package/dist/model/preferences.d.ts +155 -0
- package/dist/model/preferences.js +84 -0
- package/dist/model/prefs-buckets.d.ts +173 -0
- package/dist/model/prefs-buckets.js +71 -0
- package/dist/model/relation-filters.d.ts +45 -0
- package/dist/model/relation-filters.js +78 -0
- package/dist/model/render-count.d.ts +2 -0
- package/dist/model/render-count.js +24 -0
- package/dist/model/row-icon.d.ts +23 -0
- package/dist/model/row-icon.js +5 -0
- package/dist/model/view-rules.d.ts +73 -0
- package/dist/model/view-rules.js +216 -0
- package/dist/provider/ViewsProvider.d.ts +26 -0
- package/dist/provider/ViewsProvider.js +16 -0
- package/dist/provider/components.d.ts +230 -0
- package/dist/provider/components.js +3 -0
- package/dist/provider/context.d.ts +20 -0
- package/dist/provider/context.js +10 -0
- package/dist/provider/icons.d.ts +6 -0
- package/dist/provider/icons.js +1 -0
- package/dist/provider/menu-groups.d.ts +8 -0
- package/dist/provider/menu-groups.js +38 -0
- package/dist/provider/ports.d.ts +57 -0
- package/dist/provider/ports.js +9 -0
- package/dist/react.d.ts +9 -0
- package/dist/react.js +4 -0
- package/dist/selection/SelectCheckbox.d.ts +17 -0
- package/dist/selection/SelectCheckbox.js +11 -0
- package/dist/selection/index.d.ts +7 -0
- package/dist/selection/index.js +6 -0
- package/dist/selection/model.d.ts +55 -0
- package/dist/selection/model.js +86 -0
- package/dist/selection/row-click.d.ts +35 -0
- package/dist/selection/row-click.js +20 -0
- package/dist/selection/types.d.ts +17 -0
- package/dist/selection/types.js +1 -0
- package/dist/selection/useCheckDragSelect.d.ts +61 -0
- package/dist/selection/useCheckDragSelect.js +165 -0
- package/dist/selection/useListSelection.d.ts +39 -0
- package/dist/selection/useListSelection.js +48 -0
- package/dist/selection/useListSelectionShortcuts.d.ts +6 -0
- package/dist/selection/useListSelectionShortcuts.js +14 -0
- package/dist/selection/useRestIntent.d.ts +18 -0
- package/dist/selection/useRestIntent.js +35 -0
- package/docs/contract.md +525 -0
- package/docs/getting-started.md +250 -0
- package/docs/guides/atoms.md +245 -0
- package/docs/guides/cells.md +302 -0
- package/docs/guides/columns.md +412 -0
- package/docs/guides/display.md +203 -0
- package/docs/guides/editors.md +404 -0
- package/docs/guides/ports.md +246 -0
- package/docs/guides/selection.md +270 -0
- package/docs/guides/the-grid.md +677 -0
- package/docs/guides/the-provider.md +446 -0
- package/docs/index.md +50 -0
- package/docs/install.md +67 -0
- package/docs/reference/cells.md +28 -0
- package/docs/reference/display.md +42 -0
- package/docs/reference/editors-chips.md +6 -0
- package/docs/reference/editors-date.md +6 -0
- package/docs/reference/editors-location.md +10 -0
- package/docs/reference/editors-name.md +6 -0
- package/docs/reference/editors-number.md +11 -0
- package/docs/reference/editors-open-values.md +9 -0
- package/docs/reference/editors-range.md +6 -0
- package/docs/reference/editors-relation.md +9 -0
- package/docs/reference/editors-select.md +8 -0
- package/docs/reference/editors-session.md +9 -0
- package/docs/reference/editors-value-list.md +6 -0
- package/docs/reference/editors.md +5 -0
- package/docs/reference/grid.md +39 -0
- package/docs/reference/react.md +86 -0
- package/docs/reference/selection.md +33 -0
- package/docs/reference/views.md +601 -0
- package/docs/reshaping.md +19 -0
- package/package.json +118 -3
- package/skills/views/SKILL.md +102 -0
package/docs/contract.md
ADDED
|
@@ -0,0 +1,525 @@
|
|
|
1
|
+
# The rendering contract
|
|
2
|
+
|
|
3
|
+
The names the rendering speaks to the engine through, and the names an app hands in. Every name here
|
|
4
|
+
is public; nothing outside this list is. `src/contract.ts` holds the slots, states, tokens, component
|
|
5
|
+
names, port names, icon names and message namespaces as typed constants, and `src/contract.test.ts`
|
|
6
|
+
pins them to this file: a constant this file does not name, and a slot, state or `--vk-*` token this
|
|
7
|
+
file names that no constant holds, fail the package's tests. The getters, the row-state keys and the
|
|
8
|
+
ports' methods are named here only, until the engine that implements them lands. Renaming a name
|
|
9
|
+
after a second app holds a copy is a codemod across every app, so a rename is a changelog line and a
|
|
10
|
+
codemod, never a quiet edit.
|
|
11
|
+
|
|
12
|
+
The prefix is `vk`, and it goes on what shares a global namespace: the CSS variables (`--vk-*`) and
|
|
13
|
+
the `data-slot` values (`vk-grid-row`), because `data-slot` is one attribute shared by every
|
|
14
|
+
component copy in an app. States are bare `data-*` attributes on the package's own elements, read
|
|
15
|
+
beside the slot. Message keys live under `views.*`, which is their namespace.
|
|
16
|
+
|
|
17
|
+
## Slots
|
|
18
|
+
|
|
19
|
+
The parts of the grid, as `data-slot` values on the element that draws each. A skin styles a part
|
|
20
|
+
through its slot (`[data-slot="vk-grid-row"]`), never through a class name the package happens to
|
|
21
|
+
use; the prefix keeps that selector from reaching an element of the app's own.
|
|
22
|
+
|
|
23
|
+
| slot | the element |
|
|
24
|
+
| ------------------------------------ | --------------------------------------------------------- |
|
|
25
|
+
| `data-slot="vk-grid"` | the grid's frame: the scroll container |
|
|
26
|
+
| `data-slot="vk-grid-header"` | the header row |
|
|
27
|
+
| `data-slot="vk-grid-header-cell"` | one column's header |
|
|
28
|
+
| `data-slot="vk-grid-row"` | one record's row |
|
|
29
|
+
| `data-slot="vk-grid-cell"` | one value |
|
|
30
|
+
| `data-slot="vk-grid-group"` | one group's band and its rows |
|
|
31
|
+
| `data-slot="vk-grid-group-header"` | a group's name and figures |
|
|
32
|
+
| `data-slot="vk-grid-footer"` | the footer row |
|
|
33
|
+
| `data-slot="vk-grid-footer-cell"` | one column's figure |
|
|
34
|
+
| `data-slot="vk-grid-rail"` | the left rail: the checkbox lane |
|
|
35
|
+
| `data-slot="vk-grid-tail"` | the right tail: a row's ⋯, the header's + Add column |
|
|
36
|
+
| `data-slot="vk-grid-row-more"` | the row's ⋯ itself: it opens the row's menu |
|
|
37
|
+
| `data-slot="vk-grid-editor"` | the open editor over a cell |
|
|
38
|
+
| `data-slot="vk-grid-outline"` | the outline around the focused cell or the selected range |
|
|
39
|
+
| `data-slot="vk-grid-resize-handle"` | a column's resize handle |
|
|
40
|
+
| `data-slot="vk-grid-column-menu"` | the header menu |
|
|
41
|
+
| `data-slot="vk-grid-flyout"` | a flyout a menu row opens beside its menu |
|
|
42
|
+
| `data-slot="vk-grid-group-menu"` | a group band's menu |
|
|
43
|
+
| `data-slot="vk-grid-aggregate-menu"` | the footer's figure picker |
|
|
44
|
+
|
|
45
|
+
Board's slots (`vk-board`, `vk-board-lane`, `vk-board-lane-header`, `vk-board-card`,
|
|
46
|
+
`vk-board-add-card`) join this table when the board arrives.
|
|
47
|
+
|
|
48
|
+
## States
|
|
49
|
+
|
|
50
|
+
Flags the rendering styles, present as an attribute when true and absent when false, so a skin
|
|
51
|
+
writes `[data-selected]` and `data-[selected]:bg-…`. `data-range-edge` carries a value: one or more of
|
|
52
|
+
`top`, `right`, `bottom`, `left`, space-separated.
|
|
53
|
+
|
|
54
|
+
| state | on | means |
|
|
55
|
+
| ----------------- | ----------------- | ------------------------------------------------------ |
|
|
56
|
+
| `data-focused` | cell | the keyboard focus is here |
|
|
57
|
+
| `data-selected` | row | the row is checked |
|
|
58
|
+
| `data-editing` | cell | an editor is open here |
|
|
59
|
+
| `data-in-range` | cell | inside the selected range |
|
|
60
|
+
| `data-range-edge` | cell | which edges of the range this cell draws |
|
|
61
|
+
| `data-pending` | cell | a write is in flight |
|
|
62
|
+
| `data-invalid` | cell | the last commit was refused |
|
|
63
|
+
| `data-dragging` | header cell, row | being dragged |
|
|
64
|
+
| `data-empty` | cell, grid | no value; no rows |
|
|
65
|
+
| `data-frozen` | header cell, cell | pinned to the left edge |
|
|
66
|
+
| `data-scrolled` | grid | the content has scrolled under the header |
|
|
67
|
+
| `data-parked` | grid | the identity columns are parked behind the frozen band |
|
|
68
|
+
|
|
69
|
+
## Getters
|
|
70
|
+
|
|
71
|
+
The engine's functions the rendering calls. They return only stable structure — role, ARIA indices,
|
|
72
|
+
`data-*` identifiers, geometry — and carry no per-cell handlers; they are pure functions of their
|
|
73
|
+
arguments, created once per engine.
|
|
74
|
+
|
|
75
|
+
- `getGridProps()`
|
|
76
|
+
- `getHeaderProps(colId)`
|
|
77
|
+
- `getRowProps(rowKey, index)`
|
|
78
|
+
- `getCellProps(rowKey, colId, colIndex)`
|
|
79
|
+
|
|
80
|
+
## Row state
|
|
81
|
+
|
|
82
|
+
The slice `useGridRowState(rowKey)` returns, and the only thing that changes while the person works:
|
|
83
|
+
`focusedCol`, `editingCol`, `spans`, `selected`, `pending`, `invalid`. A row re-renders when its slice
|
|
84
|
+
changes and at no other time.
|
|
85
|
+
|
|
86
|
+
## Tokens
|
|
87
|
+
|
|
88
|
+
**The package owns geometry and density.** Each is a CSS variable the grid sets on its
|
|
89
|
+
frame from its scale and its state; a skin reads them and an app overrides them on the frame.
|
|
90
|
+
|
|
91
|
+
| token | what it is |
|
|
92
|
+
| ----------------- | ----------------------------------------- |
|
|
93
|
+
| `--vk-scale` | the density multiplier |
|
|
94
|
+
| `--vk-row-h` | row height |
|
|
95
|
+
| `--vk-head-h` | header height |
|
|
96
|
+
| `--vk-footer-h` | footer height |
|
|
97
|
+
| `--vk-label-h` | group band height |
|
|
98
|
+
| `--vk-line-h` | a cell's line height |
|
|
99
|
+
| `--vk-chrome-h` | the chrome above the first row |
|
|
100
|
+
| `--vk-px` | horizontal cell padding |
|
|
101
|
+
| `--vk-cell-py` | vertical cell padding |
|
|
102
|
+
| `--vk-tail-py` | the tail button's vertical padding |
|
|
103
|
+
| `--vk-tail-pl` | the tail button's left padding |
|
|
104
|
+
| `--vk-rail-w` | the left rail's width |
|
|
105
|
+
| `--vk-rail-gap` | the gap between rail and first cell |
|
|
106
|
+
| `--vk-tail-w` | the right tail's width |
|
|
107
|
+
| `--vk-indent` | the group indent |
|
|
108
|
+
| `--vk-frozen-w` | the frozen band's width |
|
|
109
|
+
| `--vk-scroll-mt` | scroll-margin-top for a focused row |
|
|
110
|
+
| `--vk-glyph` | glyph size in cells |
|
|
111
|
+
| `--vk-head-glyph` | glyph size in the header |
|
|
112
|
+
| `--vk-text` | cell text size |
|
|
113
|
+
| `--vk-text-xs` | small text size |
|
|
114
|
+
| `--vk-text-10` | the smallest text size |
|
|
115
|
+
| `--vk-head-text` | header text size |
|
|
116
|
+
| `--vk-scrolled` | 0 or 1: content scrolled under the header |
|
|
117
|
+
| `--vk-parked` | 0 or 1: identity columns parked |
|
|
118
|
+
| `--vk-frozen-on` | 0 or 1: the frozen band is on |
|
|
119
|
+
| `--vk-row-py` | a rows view's vertical row padding |
|
|
120
|
+
| `--vk-head-mb` | the space under a rows view's header |
|
|
121
|
+
| `--vk-row-gap` | the gap inside a rows view's row |
|
|
122
|
+
|
|
123
|
+
`densityStyle(density)` writes the last three on the root of a rows view an app draws itself; its
|
|
124
|
+
rows read them.
|
|
125
|
+
|
|
126
|
+
**Colour is the app's, by the package's names.** The rendering paints every colour through a CSS
|
|
127
|
+
variable the app declares, spelled in a class as `text-(color:--vk-fg)` and in a value as
|
|
128
|
+
`var(--vk-ground)`, and names no variable of the app's own. An app maps each name onto its tokens
|
|
129
|
+
once; `docs/install.md` holds the block for stock shadcn.
|
|
130
|
+
|
|
131
|
+
| colour | what it paints |
|
|
132
|
+
| ---------------------- | ----------------------------------------------------- |
|
|
133
|
+
| `--vk-fg` | text |
|
|
134
|
+
| `--vk-fg-subtle` | secondary text: labels, meta, glyphs |
|
|
135
|
+
| `--vk-fg-subtlest` | hints: placeholders, units, a suffix |
|
|
136
|
+
| `--vk-fg-brand` | brand text: a link, a hovered chip |
|
|
137
|
+
| `--vk-fg-selected` | the chosen mark in a picker |
|
|
138
|
+
| `--vk-fg-on-brand` | text on a brand fill |
|
|
139
|
+
| `--vk-ground` | the ground a part paints, where it paints one |
|
|
140
|
+
| `--vk-overlay` | a floating panel's ground |
|
|
141
|
+
| `--vk-hovered` | the hover of the ground a part sits on |
|
|
142
|
+
| `--vk-pressed` | the pressed or open state of that ground |
|
|
143
|
+
| `--vk-neutral` | a neutral fill: a well, a chip, a track |
|
|
144
|
+
| `--vk-neutral-hovered` | a neutral fill under the pointer or focus |
|
|
145
|
+
| `--vk-brand` | a brand fill: a bar, a checked box, a selection edge |
|
|
146
|
+
| `--vk-brand-subtlest` | a brand wash |
|
|
147
|
+
| `--vk-danger` | a destructive colour |
|
|
148
|
+
| `--vk-danger-subtlest` | a destructive wash |
|
|
149
|
+
| `--vk-border` | the default line |
|
|
150
|
+
| `--vk-border-subtle` | a table's line |
|
|
151
|
+
| `--vk-border-bold` | a strong line |
|
|
152
|
+
| `--vk-border-brand` | a focused or editing ring |
|
|
153
|
+
|
|
154
|
+
`--vk-hovered` and `--vk-pressed` are the ground's own: an app whose grounds each tune their states
|
|
155
|
+
declares both wherever a ground declares its own, so a part takes the states of the ground nearest it.
|
|
156
|
+
The default atoms and the display also read `--vk-success`, `--vk-warning`, `--vk-info`,
|
|
157
|
+
`--vk-label-blue`, `--vk-label-green`, `--vk-label-amber`, `--vk-label-red`, `--vk-label-purple`,
|
|
158
|
+
`--vk-label-pink` and `--vk-label-teal` when the app declares them, each with a built-in fallback. The
|
|
159
|
+
corners come from the app's Tailwind radius scale.
|
|
160
|
+
|
|
161
|
+
**The page gutter is the app's, if it has one.** `--vk-gutter` is the side padding a page gives its
|
|
162
|
+
content: the grid's rows run edge to edge and line their content up with it. An app that pads its
|
|
163
|
+
pages declares it once, onto its own padding; undeclared, the grid reads `0px` and sits flush with its
|
|
164
|
+
container. `--vk-pinned-top` is how far down the surface's own pinned chrome reaches: the grid's
|
|
165
|
+
sticky header row and each group's header stop under it, not behind it. An app that pins something
|
|
166
|
+
over a grid (a tab strip, a toolbar) declares it on the element that scrolls the grid, onto the
|
|
167
|
+
height of what it pins there; undeclared, the grid reads `0px` and its header sticks at the top.
|
|
168
|
+
|
|
169
|
+
**The grid's own variables are not public.** The grid sets `--vk-drag-shift` (a header cell's
|
|
170
|
+
offset while its column is dragged to a new place) and `--vk-col-w-<id>` (one column's resolved
|
|
171
|
+
width, one per column) for itself. They carry the prefix because they share the global namespace;
|
|
172
|
+
an app neither sets nor reads them, and they may change in any release.
|
|
173
|
+
|
|
174
|
+
## The components map
|
|
175
|
+
|
|
176
|
+
The primitives an app hands in through `ViewsProvider`, typed in `src/provider/components.ts`.
|
|
177
|
+
Modelled on Base UI's shapes, so an app on Base UI wraps its own copies thinly and an app on Radix
|
|
178
|
+
absorbs the difference in its adapter. What the types promise is a controlled `open` with
|
|
179
|
+
`onOpenChange(open, details)`, an `anchor` rather than a trigger child on the popover and the menu,
|
|
180
|
+
and no `asChild`; the tooltip takes the element it wraps as `children`. The slots are the ones the
|
|
181
|
+
grid's editors and menus use, each in Base UI's shape, and an adapter on Radix and one on Base UI
|
|
182
|
+
both fill every one.
|
|
183
|
+
|
|
184
|
+
`Button` · `Popover` · `Tooltip` · `Checkbox` · `Menu` · `Command` · `Calendar` · `Collapse` · `Sheet` · `AppIcon` · `Markdown`
|
|
185
|
+
|
|
186
|
+
The popover takes `alignOffset`, `initialFocus` (false keeps focus where it was when the popup
|
|
187
|
+
opens; the editor that then takes focus does so with `preventScroll`, so an adapter places its popup
|
|
188
|
+
however it likes, with no `fixed` positioning to hide a jump), and two vetoes, `onOutsidePress`
|
|
189
|
+
and `onEscape`, each returning `false` to keep it open. `onOutsidePress` is handed the pointer press, its `target` where the press landed, also when the
|
|
190
|
+
focus that press moves is what would close the popup: a vetoed press holds against its focus too,
|
|
191
|
+
and focus leaving by keyboard (a Tab out) closes without asking. Its
|
|
192
|
+
`chrome` is `panel` (the app's card popover) or `menu` (the app's menu panel, for a list); a panel
|
|
193
|
+
click reaches `onPanelClick`, and `panelData` sets `data-*` attributes on the popup; its `style` carries what a class cannot say, a width that follows a cell. The command
|
|
194
|
+
list's root takes `shouldFilter`, `filter` and `loop` (the arrows wrap); an item takes `chosen`: the app colours the item as
|
|
195
|
+
its chosen row, and the package's row inside draws the check, so the item draws no tick of its own; its input takes a `ref` (the place editor focuses its search through it), `onKeyDown`, and `chrome`
|
|
196
|
+
`search` or `bare` (the input without the search row); its empty state and groups take a class. The
|
|
197
|
+
calendar takes a controlled `month` (`YYYY-MM`) with `onMonthChange`, a `dropdown` caption, and the
|
|
198
|
+
`startMonth` and `endMonth` its pickers offer, and `locale`, the conventions' locale, in which it
|
|
199
|
+
draws its month and weekday names and starts its week; an adapter may ignore it and keep its
|
|
200
|
+
calendar's own. The tooltip takes `align` and a class; the checkbox takes `checked` and, for a box
|
|
201
|
+
ticked partly (some, not all), `indeterminate`, a press on which hands `true` while `checked` is false; its `onCheckedChange` hands, as its second argument, `{ event }`, the press that changed it, as Base UI reports it; its `partialTone` (`muted` or `brand`) colours the partial mark; the collapse takes `clipClassName`, a class on the box that crops; the app mounts
|
|
202
|
+
one tooltip provider above the views, and a tooltip never mounts its own. A menu item may carry a
|
|
203
|
+
`shortcut` hint and an `href`; a `checked` row is checkable and closes the menu like any row; an
|
|
204
|
+
item's `children` are a group, its rows drawn in place under the item's label, never a flyout, and
|
|
205
|
+
the group's own `onSelect`, `href` and `checked` are ignored, and a group marked `disabled` disables every row under it, at every depth: the provider hands your `Menu` those rows already `disabled`, so you draw each row by its own flag. `AppIcon` is the app's own icon component by the app's own names, for
|
|
206
|
+
the glyphs a host declares (a row's icon, a binding's icon, an option's icon), drawn on the first paint (rows are measured as they mount); the semantic glyphs the rendering itself
|
|
207
|
+
needs are a port, by meaning (below). `Markdown` is the app's markdown renderer, handed the stored text whole; the
|
|
208
|
+
package draws rich text through it and parses none.
|
|
209
|
+
|
|
210
|
+
A popup reports why it closed through `onOpenChange`'s `details.reason`: `trigger-press`,
|
|
211
|
+
`outside-press`, `escape-key`, `focus-out`, `item-press`, `close-press` (a close button inside it) or
|
|
212
|
+
`swipe` (a sheet dragged away), by Base UI's names; any other reason is `none`. The package sets no
|
|
213
|
+
stacking order on a popup it opens: the app's popups sit above its own modals and drawers, and a
|
|
214
|
+
popup opened later sits above the one it opened from.
|
|
215
|
+
|
|
216
|
+
The package ships none of them and depends on neither library.
|
|
217
|
+
|
|
218
|
+
### Writing an adapter
|
|
219
|
+
|
|
220
|
+
What a Base UI adapter over shadcn copies does where its copies stop short of a slot.
|
|
221
|
+
|
|
222
|
+
**The menu.** The map's `Menu` has an anchor and no trigger, and no flyouts. Build it from the menu
|
|
223
|
+
library's root, positioner and popup, handing the anchor to the positioner, where your copy's content
|
|
224
|
+
doesn't forward one; with no flyouts, a root needs no trigger of its own.
|
|
225
|
+
|
|
226
|
+
**A disabled group.** Nothing to do: its rows reach you already `disabled`.
|
|
227
|
+
|
|
228
|
+
**`chrome: "menu"`.** It is your menu panel's surface: no inset, because the list inside carries its
|
|
229
|
+
own, and no card width: it is as wide as its list. Where your copy has only the card popover, lay your
|
|
230
|
+
menu classes over it.
|
|
231
|
+
|
|
232
|
+
**The command item's chosen mark.** Colour the item as your chosen row; the row inside draws the
|
|
233
|
+
check. Where your copy's item draws a tick of its own, hide it.
|
|
234
|
+
|
|
235
|
+
**`chrome: "bare"`.** The input alone, without the search row's glyph and divider. Where your copy
|
|
236
|
+
has only the search row, reach the command library's own input.
|
|
237
|
+
|
|
238
|
+
**The sheet's `snap`.** Map `full`, `half`, `peek` and `auto` onto your drawer's snap points if it
|
|
239
|
+
has them, or ignore `snap`.
|
|
240
|
+
|
|
241
|
+
**`AppIcon`.** It draws on the first paint, because rows are measured. Use a static record of your
|
|
242
|
+
icons, not one loaded on demand.
|
|
243
|
+
|
|
244
|
+
**Stacking.** Your popup's layer sits above your modal tier, and a later popup above an earlier one,
|
|
245
|
+
in your adapter: a positioner your copy isolates at a lower layer holds the popup under a modal.
|
|
246
|
+
|
|
247
|
+
**The press veto.** Where your popover closes on the focus an outside press moves before the press's
|
|
248
|
+
own event reaches it, keep the last pointer press and ask `onOutsidePress` with it; when the veto
|
|
249
|
+
refuses, refuse that focus-out too.
|
|
250
|
+
|
|
251
|
+
**Close reasons.** Pass your library's `close-press` and `swipe` through; any other reason the
|
|
252
|
+
contract doesn't name is `none`.
|
|
253
|
+
|
|
254
|
+
## The atoms
|
|
255
|
+
|
|
256
|
+
The pieces the rendering is built from, and the app's own pieces it cannot draw itself, typed in `src/atoms/types.ts`: `List` (the rows'
|
|
257
|
+
container: the inset a run of rows sits in, inside a panel or a command list's group), `Row` (a whole row,
|
|
258
|
+
a button or, with `interactive={false}`, a static line), `RowContent` (a row's inside, for inside a
|
|
259
|
+
command list's item, which owns the element and the highlight), `TickBox` (a paint-only tick box),
|
|
260
|
+
`StatusBadge` (a pill by status slot), `StatusMarker` (an attention badge that opens its reason) and
|
|
261
|
+
`Tag` (a category chip, removable, with an optional leading glyph), `CommandMenu` (a `command` cell's verb menu, opened from the trigger the cell drew; the default is the components map's `Menu`), `RowMenu` (the row's right-click menu, around the row: Open page, the rows the rendering builds, Delete; the default is the components map's `Menu` at the pointer, opened by a right-click or the row's ⋯ (`data-slot="vk-grid-row-more"`), wrapped in `data-slot="vk-row-menu"`; its Delete asks the `confirm` port with `views.menus.row-delete-confirm` (the browser's own confirm when you hand none), and a delete that rejects says so through the toast port's `error` with `views.menus.row-delete-failed`; a long-press on a phone opens nothing) and `RelationLink` (where a relation chip goes, around the chip the display drew; the default goes nowhere), `Loading` (a wait: the list reloading, or more rows arriving; the default is a plain ring) `LoadMore` (how a list asks for its next page; the default watches a sentinel past the last row) and `PlatformMark` (a link's platform, drawn before it, read from its address with the conventions' platforms; the default draws nothing, so a link looks plain, and the package ships no brand art, so an app that wants marks draws its own by the platform's key into `data-slot="vk-platform"`). Each ships as a default, exported as `DEFAULT_VIEWS_ATOMS`, drawn
|
|
262
|
+
from the app's colours; an app swaps any of them through the provider's `atoms`, and the rest
|
|
263
|
+
stay the defaults.
|
|
264
|
+
|
|
265
|
+
A row's `size` is `compact` (13px: a command list's rows, a list of values) or `regular` (the app's
|
|
266
|
+
menu size, the default). Its label truncates when it is text and is laid out in a row when it is a
|
|
267
|
+
node — a badge, a link — so a chip sits on the row's centre; `wrap` lets a long label break instead.
|
|
268
|
+
A row in the default tone takes its colour from what it sits in, so a command item's chosen mark and
|
|
269
|
+
highlight read through it; a `muted` row brightens on hover when it is itself the button.
|
|
270
|
+
A row's `detail` is what it says at its right edge, in the subtle colour: a setting's current choice,
|
|
271
|
+
or a live sample; a chosen row draws its detail in the brand colour and no check, so a column of
|
|
272
|
+
samples stays in line. A row that opens a flyout beside its menu takes `opens` (`aria-haspopup="dialog"`,
|
|
273
|
+
since the flyout is the components map's `Popover`, a dialog of plain rows; and `aria-expanded` from `open`),
|
|
274
|
+
and `open` while that flyout is up (`data-open`, the pressed ground).
|
|
275
|
+
|
|
276
|
+
The defaults mark themselves with `data-slot="vk-list"`, `data-slot="vk-row"`, `data-slot="vk-row-content"`,
|
|
277
|
+
`data-slot="vk-tick"`, `data-slot="vk-status"`, `data-slot="vk-marker"`, `data-slot="vk-tag"`, `data-slot="vk-command-menu"`, `data-slot="vk-relation-link"`, `data-slot="vk-loading"`, `data-slot="vk-load-more"`, `data-slot="vk-platform"` and `data-slot="vk-row-menu"`, and
|
|
278
|
+
with the states `data-chosen`, `data-disabled`, `data-muted`, `data-checked`, `data-open` (flags),
|
|
279
|
+
`data-status` (the slot's name) and `data-platform` (a link's platform key). A swapped atom marks itself as its app does.
|
|
280
|
+
|
|
281
|
+
Lists that scroll wear the class `scrollbar-overlay`, which an app may define (to show the OS
|
|
282
|
+
overlay scrollbar, say); without it the class does nothing.
|
|
283
|
+
|
|
284
|
+
## Ports
|
|
285
|
+
|
|
286
|
+
Runtime services the app hands in through the provider, typed in `src/provider/ports.ts`:
|
|
287
|
+
|
|
288
|
+
- `toast` — `success(message)`, `error(message)`, `info(message)`, `warning(message, { description })` (a change the person did not make).
|
|
289
|
+
- `haptics` — `selection()`, `impact(style)`, `notification(type)`; an app without a device hands in no-ops.
|
|
290
|
+
- `clipboard` — `writeText(text)` resolving to whether it succeeded; `readText()` resolving to the text or `null`.
|
|
291
|
+
- `viewPrefs` — `get(key)`, `set(key, value)`, `subscribe(key, listener)`: a per-device store for state a view keeps between visits. No view in this release reads it; the grid's preferences come in through `useGridTablePrefs`, from wherever the host keeps them.
|
|
292
|
+
- `confirm` — `confirm({ message, confirmLabel, subject, destructive })` resolving to whether the person said yes; asked before a row's Delete, `subject` being the host's `deleteLabel`. Optional: an app that hands none gets the browser's own confirm with `message`, and a rejection or a throw counts as no. `useViews().ports.confirm` is always a function.
|
|
293
|
+
|
|
294
|
+
## Icons
|
|
295
|
+
|
|
296
|
+
The glyphs the rendering asks for, by meaning. The app maps each name to a component taking
|
|
297
|
+
`className`. Field types: `text` `longText` `number` `percent` `currency` `date` `datetime` `duration`
|
|
298
|
+
`boolean` `select` `status` `multiselect` `relation` `user` `url` `domain` `email` `phone` `location` `name` `actor`
|
|
299
|
+
`rich_text` `range` `lookup` `rollup` `formula` `computed`. Who did it: `automation` `apiKey` `system` (a member wears `user`). Actions: `add` `edit` `delete` `copy` `cut` `paste` `clear` `hide` `show` `lock`
|
|
300
|
+
`pin` `wrap` `more` `close` `check` `warning` `drag` `resize` `open` `selectRow`. Navigation and order: `chevronDown`
|
|
301
|
+
`chevronRight` `caretDown` `caretRight` `sortAsc` `sortDesc` `enter`. Figures: `calendar` `time` `progress`.
|
|
302
|
+
The grid's menus: `moveLeft` `moveRight` `group` `clearSort` `sortRowsUp` `sortRowsDown`. `sortRowsUp` and
|
|
303
|
+
`sortRowsDown` are a menu's verbs, sorting the rows by a column; `sortAsc` and `sortDesc` are the mark a
|
|
304
|
+
sorted header wears.
|
|
305
|
+
|
|
306
|
+
An app maps its own icon names onto these in its adapter; a glyph the rendering needs that is not
|
|
307
|
+
here is added here first, with a changelog line.
|
|
308
|
+
|
|
309
|
+
## Message keys
|
|
310
|
+
|
|
311
|
+
The package words only its own strings; a string `@viewkitjs/fields` already keys stays a fields
|
|
312
|
+
message, read from the conventions the provider carries. The package's are a closed list of
|
|
313
|
+
`{ key, values }` messages under `views.grid.*`,
|
|
314
|
+
`views.editors.*`, `views.menus.*` and `views.display.*`: `views.editors.tag-remove` (`{ label }`),
|
|
315
|
+
`views.editors.marker-resolve`, `views.editors.marker-no-reason`, `views.editors.range-low` and
|
|
316
|
+
`views.editors.range-high` (a range editor's two boxes, "From" and "To"), and `views.editors.name-given`,
|
|
317
|
+
`views.editors.name-family` and `views.editors.name-full` (a name editor's three boxes); `views.editors.values-add` ("Add"), `views.editors.values-label` ("Label"), `views.editors.values-main` ("Main", the main value's mark), `views.editors.values-make-main` (`{ value }`, "Make {value} the main one") and `views.editors.values-remove` (`{ value }`, "Remove {value}") (a value list editor's rows); the place editor's: `views.editors.place-country` ("Country"), `views.editors.place-country-search` ("Search countries"), `views.editors.place-change-country` ("Change country"), `views.editors.place-region-search` ("Search"), `views.editors.place-line1` ("Address line 1"), `views.editors.place-line2` ("Address line 2"), `views.editors.place-required` (`{ label }`, "{label} *", a part its country asks for), the region's words `views.editors.place-region-area`, `views.editors.place-region-county`, `views.editors.place-region-department`, `views.editors.place-region-district`, `views.editors.place-region-do-si`, `views.editors.place-region-emirate`, `views.editors.place-region-island`, `views.editors.place-region-oblast`, `views.editors.place-region-parish`, `views.editors.place-region-prefecture`, `views.editors.place-region-province` and `views.editors.place-region-state`, the city's `views.editors.place-city-city`, `views.editors.place-city-district`, `views.editors.place-city-post-town` and `views.editors.place-city-suburb`, and the postal code's `views.editors.place-postal-eircode`, `views.editors.place-postal-pin`, `views.editors.place-postal-postal` and `views.editors.place-postal-zip` (each its word in English: "County", "Do/Si", "Post town", "PIN code", "ZIP code"); `placeWordKey(kind, word)` gives the key for a word `placeFormat` names; `views.editors.place-region` ("Region") beside the place editor's `views.editors.place-country`,
|
|
318
|
+
`views.editors.place-city-city` and `views.editors.place-postal-postal`, a place's parts in a panel;
|
|
319
|
+
`views.menus.part-row` (`{ field, part }`, one part's row in a panel: "Location · Country");
|
|
320
|
+
the grid's column menu: `views.menus.sort-asc` ("Sort ascending"), `views.menus.sort-desc`, `views.menus.sort-clear`
|
|
321
|
+
("Clear sort"), `views.menus.group-by` (`{ field }`, "Group by {field}"), `views.menus.ungroup`, `views.menus.move-left`,
|
|
322
|
+
`views.menus.move-right`, `views.menus.hide-column` ("Hide from view"), `views.menus.format` (a date's or a duration's
|
|
323
|
+
row), `views.menus.date-style` (`{ style }`: `"short"`, `"long"`, `"numeric"` or `"relative"`), `views.menus.show-time`,
|
|
324
|
+
`views.menus.duration-style` (`{ style }`: `"adaptive"`, `"clock"` or `"units"`), `views.menus.decimals`,
|
|
325
|
+
`views.menus.automatic` (the field's own decimals, an option's own colour), `views.menus.currency`,
|
|
326
|
+
`views.menus.percent-display` ("Display"), `views.menus.percent-display-option` (`{ display }`: `"text"` is "Number",
|
|
327
|
+
`"bar"`, `"ring"`), `views.menus.colour` (`{ colour }`, one of the eight option colours: "Gray" … "Teal") and
|
|
328
|
+
`views.menus.colours-reset` ("Reset colors"); a group's menu: `views.menus.group-options` (its button's label),
|
|
329
|
+
`views.menus.group-sort` ("Sort rows"), `views.menus.search`, `views.menus.group-show` ("Show"), `views.menus.group-count`
|
|
330
|
+
("Count") and `views.menus.group-hide` ("Hide group"); "+ Add column": `views.grid.add-column` (its header
|
|
331
|
+
cell), `views.menus.add-column-search` ("Search columns…"), `views.menus.add-column-no-match` (`{ query }`) and `views.menus.add-column-all-shown`; a row's menu:
|
|
332
|
+
`views.menus.copy`, `views.menus.cut`, `views.menus.paste`, `views.menus.clear` and `views.menus.edit` (a cell's lane),
|
|
333
|
+
and the plain row menu's `views.menus.row-open` ("Open page"), `views.menus.row-select` (`{ selected }`, `"true"` is
|
|
334
|
+
"Deselect", as text for a catalog's `select`), `views.menus.row-delete`, `views.menus.row-delete-confirm` (the
|
|
335
|
+
browser's confirm before a delete: "Delete this row?") and `views.menus.row-delete-failed` (the error toast when the
|
|
336
|
+
delete the host ran rejects: "Failed to delete the row");
|
|
337
|
+
the grid's own: `views.grid.figure` (`{ kind }`, a footer figure's name, `"none"` included: "None", "Sum", "Avg", "Min",
|
|
338
|
+
"Max", "Count", "Filled", "Unique", "Ratio"), `views.grid.figure-pick` ("Calculate", an empty footer cell),
|
|
339
|
+
`views.grid.loading` ("Loading rows"), the labels `views.grid.select-row`, `views.grid.select-group`,
|
|
340
|
+
`views.grid.select-all`, `views.grid.row-menu`, `views.grid.group-expand`, `views.grid.group-collapse`,
|
|
341
|
+
`views.grid.change-value`, `views.grid.value` and `views.grid.edit-value` (a long text's box, read-only or not),
|
|
342
|
+
`views.grid.read-only` and `views.grid.read-only-why` (a locked list's badge and its title); its refusals
|
|
343
|
+
`views.grid.locked` (`{ field }`), `views.grid.not-clearable`, `views.grid.computed` (`{ from }`),
|
|
344
|
+
`views.grid.cell-read-only` and `views.grid.clear-none`; its write gate's `views.grid.write-not-list`,
|
|
345
|
+
`views.grid.write-not-boolean`, `views.grid.write-marker`, `views.grid.write-not-email`, `views.grid.write-not-url`, `views.grid.write-not-link` and
|
|
346
|
+
`views.grid.write-not-linkable`; a paste's `views.grid.paste-refused`, `views.grid.paste-empty`,
|
|
347
|
+
`views.grid.paste-not-number`, `views.grid.paste-not-duration`, `views.grid.paste-not-date`,
|
|
348
|
+
`views.grid.paste-not-option`, `views.grid.paste-ambiguous-option` (a label two options share),
|
|
349
|
+
`views.grid.paste-pick` and `views.grid.paste-not-linkable` (each `{ value }`, the pasted text), `views.grid.paste-other-currency` (`{ currency }`, the record's own: an amount pasted or filled into a
|
|
350
|
+
record in another currency) and `views.grid.paste-not-range`; a paste or a fill that refused cells,
|
|
351
|
+
`views.grid.paste-skipped` and `views.grid.fill-skipped` (each `{ count, reason }`: one toast per reason, its
|
|
352
|
+
`reason` one of the refusals above in the app's words; an operation of one cell says the reason alone); and the warnings
|
|
353
|
+
`views.grid.changed-elsewhere` (`{ field }`), `views.grid.changed-elsewhere-cells` (`{ count }`),
|
|
354
|
+
`views.grid.saved-value`, `views.grid.saved-values` and `views.grid.row-left`. The functions that word a refusal
|
|
355
|
+
(`gridClearRefusal`, `columnClearRefusal`, `columnEditRefusal`, `gridEditRefusal`) take the resolver last, and
|
|
356
|
+
`gridNormalizeWrite` in its options; each defaults to `resolveViewsMessage`. And the display's words —
|
|
357
|
+
`views.display.just-now`, `views.display.in` (`{ count, unit }`, a span ahead: "in 5m"),
|
|
358
|
+
`views.display.today`, `views.display.yesterday`, `views.display.tomorrow`, `views.display.month`
|
|
359
|
+
(`{ month, length }`), `views.display.not-an-option` (a stored value its field does not name),
|
|
360
|
+
`views.display.needs-attention` (a marker's default heading), `views.display.boolean`
|
|
361
|
+
(`{ value }`, `"true"` or `"false"` as text so a catalog's `select` reads it: a text boolean with no words of its own), `views.display.show-all` (`{ count }`), and
|
|
362
|
+
`views.display.show-more` and `views.display.show-less` (rich text folded in a drawer), and
|
|
363
|
+
`views.display.phone-extension` (`{ extension }`, "ext. 12" after a phone) and `views.display.phone-as-typed`
|
|
364
|
+
(the title on a phone stored as typed).
|
|
365
|
+
A span behind now is fields' own `time.ago`. The provider's `messages` resolves them; it defaults to the
|
|
366
|
+
package's English, `resolveViewsMessage`; an app's resolver that words only some keys calls
|
|
367
|
+
`resolveViewsMessage` for the rest, since the provider does not fall back for it. A new key is a
|
|
368
|
+
change to the list and a compile error in every exhaustive resolver (a `switch` with no default)
|
|
369
|
+
that has not worded it.
|
|
370
|
+
|
|
371
|
+
## Four shapes of a value
|
|
372
|
+
|
|
373
|
+
A value takes up to four shapes on its way through a view: **stored** (what the row holds), **draft** (what an editor holds while it is open), **commit** (what the editor hands its host when it closes) and **display** (what a surface draws). Stored and commit differ on purpose, and the binding's `write` is where a host maps one onto the other.
|
|
374
|
+
|
|
375
|
+
| type | stored | draft | commit | display |
|
|
376
|
+
| -------------------------------------------- | --------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
377
|
+
| `text` | a string | the host's own input | a string | the text; a long text folds |
|
|
378
|
+
| `url`, `domain`, `email`, `phone` | a string (a phone `{ number, extension }`) | the host's own input | the typed text, which fields' `acceptFieldCommit` reads | a link (`tel:` for a phone) |
|
|
379
|
+
| the same, `multiple` | `{ value, label, main }[]`, the main one first | a row each | the whole list (`editors/value-list`) | the main value, and the rest on demand |
|
|
380
|
+
| `number`, `percent`, `currency` | a number (a currency's code fixed, or in a sibling field) | the typed text | `NumberCommit`: `{ value, unit? }` | the figure in the conventions' locale; a percent appended, never multiplied |
|
|
381
|
+
| `date` | `"2026-09-15"` | the picked day | `"2026-09-15"` | the day in the column's style |
|
|
382
|
+
| `datetime` | an ISO instant | the local day and time | `"2026-09-15T14:30"`, local: the host merges it onto the stored instant | the day and time |
|
|
383
|
+
| `boolean` | a boolean | none | a boolean, from the display control itself | a checkbox, an icon, a marker or text |
|
|
384
|
+
| `select`, `status` | the option's code | none: a pick commits | the option's code, or `""` for None on a field that may be emptied | a badge, a status by its semantic slot |
|
|
385
|
+
| `multiselect` | the codes | the chosen codes | the whole set | badges |
|
|
386
|
+
| `relation`, `user` | an id or null (ids for a many relation) | the picked id | an id, or `null` for unlinked | a chip `{ id, label, entity, avatarUrl }` the host resolves |
|
|
387
|
+
| `range` | `{ low, high }` | two boxes | `{ low, high }`, an empty box an open end | "11–50" with its unit and period |
|
|
388
|
+
| `name` | `{ full, given, family }` | three boxes | `{ full, given, family }`, or `null` | the full name, else the parts, else the host's fallback |
|
|
389
|
+
| `location` | the place's parts in its country's order | the country, then its parts | the place, or `null` (the grid has no editor for it) | the place written whole |
|
|
390
|
+
| `rich_text` | a markdown string | the host's own input; in the grid, the long-text panel | the markdown string | folded text |
|
|
391
|
+
| `actor`, `lookup`, `rollup`, `formula` | set by the system, or derived | none | none: no editor opens | a chip, the far field, the result |
|
|
392
|
+
|
|
393
|
+
A clear is the one exception to the commit column. Delete, Cut, the grid row menu's Clear and a clear over a range commit `""` for every type above but three, on a field that may be emptied: a relation (and a member) commits `null` and a multiselect `[]`, and a boolean commits `false`, whether or not it may be emptied. So a cleared number, date, name, range, select or text reaches the binding's `write` as `""`, and the `write` maps it to what the row stores for nothing.
|
|
394
|
+
|
|
395
|
+
A derived field (a lookup, a rollup, a formula) has no commit at all: no edit core, and fields' `zodFor` refuses it. `EDIT_CORES` (`@viewkitjs/views/editors`) answers which types open an edit core; `null` is the answer for a type with none, including the types edited in the host's own text box (`text`, `rich_text`, `url`, `domain`, `email`, `phone`) and `boolean`, which its display control flips.
|
|
396
|
+
|
|
397
|
+
## What an edit core never does
|
|
398
|
+
|
|
399
|
+
An editor owns its panel and what a close means. Everything else is its host's, so the same core runs in a grid cell, a drawer row, a card or a form. An edit core never:
|
|
400
|
+
|
|
401
|
+
- calls a mutation or fetches on its own (its host writes, and its host hands it candidates; the relation editor's remote search calls the host's own `search`);
|
|
402
|
+
- closes itself or owns the exit timer (the host's popover closes it, and the edit session holds the gap);
|
|
403
|
+
- reads a form library, the grid's focus or selection, or a host's list.
|
|
404
|
+
|
|
405
|
+
## A command field
|
|
406
|
+
|
|
407
|
+
A field whose changes are transitions with rules of their own (a lost deal needs a reason, a reassigned record moves what is filed against it) declares `edit.mutability: "command"` in `@viewkitjs/fields`. It is edited by verbs, never by an editor: its binding takes no `write` (`checkBinding` refuses one), `bindingWritable` answers false, and `columnFrom` marks the column `command` and never `editable`. The grid cell, the drawer row and the card each open the same menu, shaped by `FieldMenus` (field key → menu items), and the host supplies the verbs; what a verb writes goes through the host's own route for that transition. The cell opens the app's `CommandMenu` atom with the host's items, where an editable cell would open an editor, so the field does not read as frozen; handed no verbs, it is a read-only value.
|
|
408
|
+
|
|
409
|
+
## The doors
|
|
410
|
+
|
|
411
|
+
Eighteen doors, and nothing else is importable but `./package.json`. What each holds is summarised here; each door's reference page names every export, one line each, starting at [`reference/views.md`](reference/views.md).
|
|
412
|
+
|
|
413
|
+
`@viewkitjs/views`, no React at runtime, holds two things. The rendering contract, every name listed:
|
|
414
|
+
the constants `VK_PREFIX`, `GRID_SLOTS`, `GRID_STATES`, `VK_TOKENS`, `VK_COLOURS`,
|
|
415
|
+
`VK_OPTIONAL_COLOURS`, `VK_OPTIONAL_LAYOUT`, `COMPONENT_NAMES`, `ATOM_NAMES`, `ATOM_SLOTS`, `ATOM_STATES`, `PORT_NAMES`,
|
|
416
|
+
`ICON_NAMES`, `MESSAGE_NAMESPACES` and `VIEWS_MESSAGE_KEYS`; the functions `resolveViewsMessage` and `placeWordKey`; and
|
|
417
|
+
the types `GridSlot`, `GridState`, `VkToken`, `VkColour`, `VkOptionalColour`, `VkOptionalLayout`, `ComponentName`,
|
|
418
|
+
`AtomName`, `AtomSlot`, `AtomState`, `PortName`, `ViewsIconName`, `ViewsMessageNamespace`,
|
|
419
|
+
`ViewsMessageKey`, `ViewsMessage`, `ViewsMessageResolver` and `PlaceWordKey`.
|
|
420
|
+
|
|
421
|
+
And the model, by module: every export of `model/index.ts` (the column vocabulary — what a column is,
|
|
422
|
+
what may be done to it, its state, its filters, its preferences, the view rules, the aggregates) and
|
|
423
|
+
of the five model modules that barrel does not carry (`card-density`, `card-layout`, `column-format`,
|
|
424
|
+
`column-inspect`, `column-money`: the card's density and layout, a column's format, inspection and
|
|
425
|
+
money reading),
|
|
426
|
+
`filters/` (the filter registry and its types, the text, number and date rules, the filter config
|
|
427
|
+
types and their guards), `figures.ts`, `grouping/` (`ListGroup` and the group sort) and `fields/`
|
|
428
|
+
(the binding, money and currency, denomination, the write preparation, the edit-core types, number
|
|
429
|
+
edit, the format knobs and the relation source types, the host's verb-menu types (`FieldMenus`, `FieldRowMenuItem`)). A name exported by one of those modules is
|
|
430
|
+
public; nothing else at the root door is.
|
|
431
|
+
|
|
432
|
+
`@viewkitjs/views/react`, which opens with the client directive: `ViewsProvider`, `useViews()` and
|
|
433
|
+
`NOOP_PORTS`; the provider's types `ViewsProviderProps` and `ViewsContextValue`; the adapter's types
|
|
434
|
+
`ViewsComponents`, `ViewsPorts`, `ViewsIcons` and `ViewsIconProps`; the components' props
|
|
435
|
+
`ViewsButtonProps`, `ViewsPopoverProps`, `ViewsTooltipProps`, `ViewsCheckboxProps`, `ViewsMenuProps`,
|
|
436
|
+
`ViewsMenuItem`, `ViewsCommandParts`, `ViewsCalendarProps`, `ViewsCollapseProps` and
|
|
437
|
+
`ViewsSheetProps`, with their shared shapes `ViewsAnchor`, `ViewsSide`, `ViewsAlign`,
|
|
438
|
+
`ViewsCloseReason` and `ViewsOpenChange`; the ports' types `ViewsToastPort`, `ViewsHapticsPort`,
|
|
439
|
+
`ViewsClipboardPort`, `ViewsPrefsPort`, `ViewsConfirmPort`, `ViewsConfirmRequest` and `ViewsResolvedPorts` (the
|
|
440
|
+
ports `useViews()` hands on, `confirm` always there); the atoms' `DEFAULT_VIEWS_ATOMS` and types `ViewsAtoms`,
|
|
441
|
+
`ViewsListProps`, `ViewsRowProps`, `ViewsRowContentProps`, `ViewsTickBoxProps`, `ViewsStatusBadgeProps`,
|
|
442
|
+
`ViewsStatusMarkerProps`, `ViewsTagProps`, `ViewsCommandMenuProps`, `ViewsRowMenuProps`, `ViewsRowMenuItem`, `ViewsRelationLinkProps`, `ViewsLoadingProps`, `ViewsLoadMoreProps` and `ViewsPlatformMarkProps`; and, re-exported from the root door, `ComponentName`,
|
|
443
|
+
`PortName`, `ViewsIconName`, `ViewsMessage` and `ViewsMessageResolver`. The provider takes an
|
|
444
|
+
optional `presentation`, `(defaults: FieldPresentation) => FieldPresentation`: how the app's numbers,
|
|
445
|
+
dates and durations read — given the package's defaults (in the conventions' locale), return the
|
|
446
|
+
app's. It is called where a value is drawn, so the app's provider imports none of the display.
|
|
447
|
+
|
|
448
|
+
`@viewkitjs/views/display`, no client directive on the door (a server module may reach its string
|
|
449
|
+
formatters), every rendering file behind it carrying its own: `renderFieldValue` and `DISPLAY_CORES`
|
|
450
|
+
(one renderer per storage type, a plain function that answers `null` for an empty value), the string
|
|
451
|
+
formatters `formatDateValue`, `formatNumberValue` and `formatMoney`, `DEFAULT_FIELD_PRESENTATION`, `viewerFrom`,
|
|
452
|
+
`CellSuffix`, `cellTextClass`, `MultiValueCell`, `CHIP_BASE`, `CHIP_INTERACTIVE`, and the types
|
|
453
|
+
`DisplayCore`, `DisplayOptions`, `FieldPresentation`, `FieldViewerContext`, `NumberLikeFormat` and
|
|
454
|
+
`RelationWrap`. A rendered value reads the provider's conventions, wording and presentation; a string
|
|
455
|
+
formatter handed no viewer reads the neutral conventions, never the runtime's.
|
|
456
|
+
|
|
457
|
+
`@viewkitjs/views/editors`, no client directive on the door: `EDIT_CORES` (one editor per storage
|
|
458
|
+
type, `null` where a type has no panel) and `hasEditCore`. One door per editor, each opening with the
|
|
459
|
+
client directive: `@viewkitjs/views/editors/select` (`SelectEditor`, `SelectEditorHandle`,
|
|
460
|
+
`pickerOptionsFromField`, `PickerOption`), `@viewkitjs/views/editors/relation` (`RelationEditor`,
|
|
461
|
+
`RelationEditorHandle`, `RelationCreate`, `RELATION_PAGE_SIZE`, `RELATION_SEARCH_DEBOUNCE_MS`, and
|
|
462
|
+
the relation source types), `@viewkitjs/views/editors/number` (`NumberEditor`, `NumberEditorHandle`,
|
|
463
|
+
`NumberEditValue`), `@viewkitjs/views/editors/range` (`RangeEditor`, `RangeEditorHandle`: two boxes,
|
|
464
|
+
low and high, an empty box an open end), `@viewkitjs/views/editors/location` (`LocationEditor`,
|
|
465
|
+
`LocationEditorHandle`: the country first, then its parts in its order, a region from its list),
|
|
466
|
+
`@viewkitjs/views/editors/value-list` (`ValueListEditor`, `ValueListEditorHandle`: several emails, phones, links or
|
|
467
|
+
domains, a row each with its label and a main mark, committed as one list of `{ value, label, main }`, the main one
|
|
468
|
+
first; `labels: false` for a host that keeps only the values),
|
|
469
|
+
`@viewkitjs/views/editors/date` (`DateEditor`, `DateEditorHandle`) and
|
|
470
|
+
`@viewkitjs/views/editors/chips` (`ChipsEditor`, `ChipsEditorHandle`). An editor owns its panel and
|
|
471
|
+
what a close means; its host owns the popover, the anchor and the write. Its words are fields'
|
|
472
|
+
messages, read from the provider's conventions unless the host hands `message`.
|
|
473
|
+
|
|
474
|
+
`@viewkitjs/views/editors/session`, opening with the client directive: `useAnchoredEditSession` and
|
|
475
|
+
`EDITOR_EXIT_MS` — the one-answer guard and the exit gap every host that opens an editor over a value
|
|
476
|
+
shares. Its own door, so a host that needs the session does not load the six editors.
|
|
477
|
+
|
|
478
|
+
`@viewkitjs/views/editors/open-values`, opening with the client directive: `OpenValuesProvider`,
|
|
479
|
+
`useOpenValues(field)` and `offeredValues(field, known, seen)`. An open field's values (what its records
|
|
480
|
+
hold, which the app's list answers) reach every editor of it: the app provides them above a surface, and
|
|
481
|
+
a host reads them, asking once for a field's values when its editor mounts. A closed field, or no
|
|
482
|
+
provider, reads none and asks nothing. `offeredValues` is what a host offers: the declared options, then
|
|
483
|
+
the known values, then those seen, each once. `useOpenValuesContext()` reads the nearest provider whole: what a host
|
|
484
|
+
hands `buildRelationFilters` as `farValues`.
|
|
485
|
+
|
|
486
|
+
A relation's Related records row (`buildRelationFilters`) offers a far relation, user or actor by name
|
|
487
|
+
only when its target names it (`RelationFilterTarget.named`, from the host's builder) and the host hands
|
|
488
|
+
`farValues`, the values its list answers keyed by path: `farPathOf(relationKey, farKey)`, the two joined by
|
|
489
|
+
`FAR_PATH_SEPARATOR` (`.`). The row asks for a far field's values by that path when it opens; anything
|
|
490
|
+
else stays greyed.
|
|
491
|
+
|
|
492
|
+
`@viewkitjs/views/cells`, no client directive on the door: `renderTypedCellValue` (a column, its row and
|
|
493
|
+
the user's overrides, handed to the field display — a `command` column's cell opens the app's
|
|
494
|
+
`CommandMenu`, a relation goes where the app's `RelationLink` says, and a title whose identity is a
|
|
495
|
+
figure or a moment draws through its field), `renderIdentityValue` (an identity's value without the
|
|
496
|
+
title cell, for a host that draws the name in its own chrome), the column-shaped string
|
|
497
|
+
formatters `formatDate` and `formatNumber` (the viewer is the caller's) with `useCellFormat`, which
|
|
498
|
+
reads it from the provider, `resolveRowCurrency`, `legacyFieldFromColumn` and `legacyNumberLikeFormat`
|
|
499
|
+
(a column no registry field backs, read as a field), and the type `GridCellOptions`. A column's glyph
|
|
500
|
+
is the app's.
|
|
501
|
+
|
|
502
|
+
`@viewkitjs/views/selection`, no client directive on the door: `useListSelection` (a list's selection
|
|
503
|
+
over its visual order, with a range anchor and the app's haptics), `useEscapeToClear`,
|
|
504
|
+
`useCheckDragSelect` and `ROW_CHECK_ATTR` (drag down the checkbox lane to set a run), `SelectCheckbox`
|
|
505
|
+
(the app's checkbox, revealed in its gutter zone, reading the shift key off the press), the row-click
|
|
506
|
+
rules `selectFromClick`, `preventShiftTextSelect`, `ROW_INTERACTIVE_SELECTOR`, `ROW_OPEN_STOP_SELECTOR`
|
|
507
|
+
and `ROW_NO_TEXT_SELECT`, and the types `ListSelectionConfig`, `ListBatchApi`, `SelectionRetention` and
|
|
508
|
+
`UseListSelectionResult`. The bar the selection opens is the app's.
|
|
509
|
+
|
|
510
|
+
`@viewkitjs/views/grid`, no client directive on the door, every rendering file behind it carrying its
|
|
511
|
+
own: `GridTable` and its props `GridTableProps` (flat, as a host's binding hands them),
|
|
512
|
+
`useGridTablePrefs` (a grid's personal preferences: the host's prefs and their setter in, the props to spread onto `GridTable` out), the types
|
|
513
|
+
an app writes its props against, `GridSortState`, `GridGroupSortOption`, `GridCellCommitFn` and
|
|
514
|
+
`GridCellsCommitFn`, and `GridGroupByState`, `GridGroupFigure` and `GroupCountNoun`; and the helpers a
|
|
515
|
+
host's binding shares with the grid: `GridCommitContext` and `GridCommitOutcome` (what a commit was and how it ended),
|
|
516
|
+
`deriveGridSelectValues` and `deriveGridRelationValues` (the values a column's filter offers),
|
|
517
|
+
`cellCopyText` and `cellEditBaseline` (a cell's copy text and the value an edit starts from, which a
|
|
518
|
+
CSV export reuses), and `GRID_TITLE_LINK_CLASS`. The selection bar, the house menu rows, the group
|
|
519
|
+
collapse and the type icons are the app's.
|
|
520
|
+
|
|
521
|
+
## Registry items
|
|
522
|
+
|
|
523
|
+
When the copy mode ships, each view's default rendering is one registry item, tagged by the package
|
|
524
|
+
version it was cut from (`views-v0.3.0`), and an app's manifest records item, tag and content hash.
|
|
525
|
+
Named here so the copy mode inherits the vocabulary; nothing uses it yet.
|