@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
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Reshaping a view
|
|
2
|
+
|
|
3
|
+
Cheapest change first. Each step reaches further and costs more to keep current.
|
|
4
|
+
|
|
5
|
+
1. **A theme preset.** Every view follows your shadcn tokens: `--background`, `--foreground`,
|
|
6
|
+
`--primary`, `--muted`, `--border`, `--radius` and the rest the contract lists. Change the theme,
|
|
7
|
+
every view changes, no code.
|
|
8
|
+
2. **The `--vk-*` variables.** Geometry and density: row height, header height, cell padding, the
|
|
9
|
+
rail's width. Set them on the grid's frame or on a wrapper; no code.
|
|
10
|
+
3. **Wrappers and slots.** Every part carries a `data-slot`; every state a `data-*`. A stylesheet or a
|
|
11
|
+
wrapper styles `[data-slot="vk-grid-row"][data-selected]` without touching the package.
|
|
12
|
+
4. **Your own primitives.** The components map is yours: the popover, the menu, the calendar inside
|
|
13
|
+
the grid are your copies, so their look is already yours.
|
|
14
|
+
5. **A copy of the rendering.** When the copy mode ships, a view's default rendering is a registry
|
|
15
|
+
item you copy into your app and own from then on, updated by a three-way merge against the tag you
|
|
16
|
+
copied. Reach for it only when the structure itself must differ.
|
|
17
|
+
|
|
18
|
+
An `if` in a skin that is not about layout is engine code in the wrong place: file it as a package
|
|
19
|
+
issue, do not fork the rendering around it.
|
package/package.json
CHANGED
|
@@ -1,6 +1,121 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@viewkitjs/views",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "ViewKit views — the grid, board, calendar and list over typed fields: a headless engine and a default rendering written to skin discipline. By Sheaf.",
|
|
5
|
+
"license": "UNLICENSED",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"sideEffects": false,
|
|
8
|
+
"files": [
|
|
9
|
+
"dist",
|
|
10
|
+
"skills",
|
|
11
|
+
"docs",
|
|
12
|
+
"README.md",
|
|
13
|
+
"CHANGELOG.md",
|
|
14
|
+
"LICENSE.md"
|
|
15
|
+
],
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=20"
|
|
18
|
+
},
|
|
19
|
+
"exports": {
|
|
20
|
+
".": {
|
|
21
|
+
"types": "./dist/index.d.ts",
|
|
22
|
+
"default": "./dist/index.js"
|
|
23
|
+
},
|
|
24
|
+
"./react": {
|
|
25
|
+
"types": "./dist/react.d.ts",
|
|
26
|
+
"default": "./dist/react.js"
|
|
27
|
+
},
|
|
28
|
+
"./display": {
|
|
29
|
+
"types": "./dist/display/index.d.ts",
|
|
30
|
+
"default": "./dist/display/index.js"
|
|
31
|
+
},
|
|
32
|
+
"./editors": {
|
|
33
|
+
"types": "./dist/editors/edit-cores.d.ts",
|
|
34
|
+
"default": "./dist/editors/edit-cores.js"
|
|
35
|
+
},
|
|
36
|
+
"./editors/select": {
|
|
37
|
+
"types": "./dist/editors/SelectEditor.d.ts",
|
|
38
|
+
"default": "./dist/editors/SelectEditor.js"
|
|
39
|
+
},
|
|
40
|
+
"./editors/relation": {
|
|
41
|
+
"types": "./dist/editors/RelationEditor.d.ts",
|
|
42
|
+
"default": "./dist/editors/RelationEditor.js"
|
|
43
|
+
},
|
|
44
|
+
"./editors/number": {
|
|
45
|
+
"types": "./dist/editors/NumberEditor.d.ts",
|
|
46
|
+
"default": "./dist/editors/NumberEditor.js"
|
|
47
|
+
},
|
|
48
|
+
"./editors/range": {
|
|
49
|
+
"types": "./dist/editors/RangeEditor.d.ts",
|
|
50
|
+
"default": "./dist/editors/RangeEditor.js"
|
|
51
|
+
},
|
|
52
|
+
"./editors/name": {
|
|
53
|
+
"types": "./dist/editors/NameEditor.d.ts",
|
|
54
|
+
"default": "./dist/editors/NameEditor.js"
|
|
55
|
+
},
|
|
56
|
+
"./editors/location": {
|
|
57
|
+
"types": "./dist/editors/LocationEditor.d.ts",
|
|
58
|
+
"default": "./dist/editors/LocationEditor.js"
|
|
59
|
+
},
|
|
60
|
+
"./editors/value-list": {
|
|
61
|
+
"types": "./dist/editors/ValueListEditor.d.ts",
|
|
62
|
+
"default": "./dist/editors/ValueListEditor.js"
|
|
63
|
+
},
|
|
64
|
+
"./editors/date": {
|
|
65
|
+
"types": "./dist/editors/DateEditor.d.ts",
|
|
66
|
+
"default": "./dist/editors/DateEditor.js"
|
|
67
|
+
},
|
|
68
|
+
"./editors/chips": {
|
|
69
|
+
"types": "./dist/editors/ChipsEditor.d.ts",
|
|
70
|
+
"default": "./dist/editors/ChipsEditor.js"
|
|
71
|
+
},
|
|
72
|
+
"./editors/session": {
|
|
73
|
+
"types": "./dist/editors/edit-session.d.ts",
|
|
74
|
+
"default": "./dist/editors/edit-session.js"
|
|
75
|
+
},
|
|
76
|
+
"./editors/open-values": {
|
|
77
|
+
"types": "./dist/editors/open-values.d.ts",
|
|
78
|
+
"default": "./dist/editors/open-values.js"
|
|
79
|
+
},
|
|
80
|
+
"./cells": {
|
|
81
|
+
"types": "./dist/cells/index.d.ts",
|
|
82
|
+
"default": "./dist/cells/index.js"
|
|
83
|
+
},
|
|
84
|
+
"./selection": {
|
|
85
|
+
"types": "./dist/selection/index.d.ts",
|
|
86
|
+
"default": "./dist/selection/index.js"
|
|
87
|
+
},
|
|
88
|
+
"./grid": {
|
|
89
|
+
"types": "./dist/grid/index.d.ts",
|
|
90
|
+
"default": "./dist/grid/index.js"
|
|
91
|
+
},
|
|
92
|
+
"./package.json": "./package.json"
|
|
93
|
+
},
|
|
94
|
+
"publishConfig": {
|
|
95
|
+
"registry": "https://registry.npmjs.org/",
|
|
96
|
+
"access": "public"
|
|
97
|
+
},
|
|
98
|
+
"peerDependencies": {
|
|
99
|
+
"@viewkitjs/fields": "^0.9.0",
|
|
100
|
+
"react": "^19.0.0",
|
|
101
|
+
"react-dom": "^19.0.0",
|
|
102
|
+
"zod": "^4.1.12"
|
|
103
|
+
},
|
|
104
|
+
"devDependencies": {
|
|
105
|
+
"@testing-library/react": "^16.3.2",
|
|
106
|
+
"@types/node": "^20",
|
|
107
|
+
"@types/react": "^19",
|
|
108
|
+
"@types/react-dom": "^19",
|
|
109
|
+
"react": "19.2.0",
|
|
110
|
+
"react-dom": "19.2.0",
|
|
111
|
+
"typescript": "^5",
|
|
112
|
+
"vitest": "^4.1.5",
|
|
113
|
+
"zod": "^4.1.12",
|
|
114
|
+
"@viewkitjs/fields": "0.9.0"
|
|
115
|
+
},
|
|
116
|
+
"scripts": {
|
|
117
|
+
"typecheck": "tsc -p tsconfig.json",
|
|
118
|
+
"build": "node ../../../scripts/clean-package-dist.mjs viewkit/views && tsc -p tsconfig.build.json && tsc -p tsconfig.types.json && node ../../../scripts/finalize-package-declarations.mjs viewkit/views",
|
|
119
|
+
"check": "node ../../../scripts/check-views-package.mjs"
|
|
120
|
+
}
|
|
6
121
|
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: views
|
|
3
|
+
description: Mount and adapt @viewkitjs/views — the provider, the components map, the atoms, the ports, the icon names and the message keys the grid, board, calendar and list render through. Use when an application installs the views package, writes its adapter over its own UI primitives, swaps the default atoms for its own rows, badges and tags, or binds the package's messages to its translations. Do not use for field definitions (that is @viewkitjs/fields) or for persistence.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# ViewKit views
|
|
7
|
+
|
|
8
|
+
Use the package through its eighteen declared doors only, never a deep path: `@viewkitjs/views` (the
|
|
9
|
+
contract and the model), `@viewkitjs/views/react` (the provider, the atoms, the adapter's types),
|
|
10
|
+
`/display`, `/editors`, `/editors/select`, `/editors/relation`, `/editors/number`, `/editors/range`,
|
|
11
|
+
`/editors/name`, `/editors/location`, `/editors/value-list`, `/editors/date`, `/editors/chips`,
|
|
12
|
+
`/editors/session`, `/editors/open-values`, `/cells`, `/selection` and `/grid`. The package's docs
|
|
13
|
+
start at `docs/index.md`: `docs/getting-started.md` goes from install to a grid on screen, a guide per
|
|
14
|
+
concept sits in `docs/guides/`, and `docs/reference/` names every export of each door.
|
|
15
|
+
|
|
16
|
+
## Mount the provider once
|
|
17
|
+
|
|
18
|
+
Every view reads its primitives, its atoms, its icons, its ports, its wording and its field
|
|
19
|
+
conventions from one `ViewsProvider` above it. Mount it once, at the app's client root. The
|
|
20
|
+
rendering paints through its own colour names (`--vk-fg`, `--vk-ground`, …), which your stylesheet
|
|
21
|
+
declares once: `docs/install.md` step 3 holds the block for stock shadcn.
|
|
22
|
+
|
|
23
|
+
<!-- viewkit-example:provider -->
|
|
24
|
+
|
|
25
|
+
```tsx
|
|
26
|
+
"use client";
|
|
27
|
+
import type { ReactNode } from "react";
|
|
28
|
+
import { defineConventions } from "@viewkitjs/fields";
|
|
29
|
+
import {
|
|
30
|
+
ViewsProvider,
|
|
31
|
+
type ViewsAtoms,
|
|
32
|
+
type ViewsComponents,
|
|
33
|
+
type ViewsIcons,
|
|
34
|
+
type ViewsPorts,
|
|
35
|
+
} from "@viewkitjs/views/react";
|
|
36
|
+
|
|
37
|
+
declare const components: ViewsComponents;
|
|
38
|
+
declare const icons: ViewsIcons;
|
|
39
|
+
declare const ports: ViewsPorts;
|
|
40
|
+
declare const MyTag: ViewsAtoms["Tag"];
|
|
41
|
+
|
|
42
|
+
const conventions = defineConventions({ locale: "en-GB", timeZone: "UTC" });
|
|
43
|
+
|
|
44
|
+
export function AppViews({ children }: { children: ReactNode }) {
|
|
45
|
+
return (
|
|
46
|
+
<ViewsProvider
|
|
47
|
+
components={components}
|
|
48
|
+
icons={icons}
|
|
49
|
+
ports={ports}
|
|
50
|
+
conventions={conventions}
|
|
51
|
+
atoms={{ Tag: MyTag }}
|
|
52
|
+
>
|
|
53
|
+
{children}
|
|
54
|
+
</ViewsProvider>
|
|
55
|
+
);
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Write the adapter against the contract
|
|
60
|
+
|
|
61
|
+
`docs/contract.md` lists the eleven components, the five ports (`confirm` optional) and the icon names. Implement
|
|
62
|
+
`ViewsComponents` over your own shadcn copies: a controlled `open` with `onOpenChange(open, details)`,
|
|
63
|
+
an `anchor` element or ref on the popover and the menu, and no `asChild`; `AppIcon` is your own
|
|
64
|
+
icon component by your own names. The shapes are Base UI's; `docs/contract.md`'s "Writing an
|
|
65
|
+
adapter" says what a Base UI adapter does where its copies stop short. Implement `ViewsIcons` by meaning
|
|
66
|
+
(`sortAsc`, `relation`, `more`), never by a library's glyph name. Hand in `ViewsPorts` from your own
|
|
67
|
+
toast, haptics, clipboard and a per-device store.
|
|
68
|
+
|
|
69
|
+
## Bind the messages and swap the atoms
|
|
70
|
+
|
|
71
|
+
The package words only its own strings — a closed list of `{ key, values }` messages under
|
|
72
|
+
`views.editors.*`, `views.display.*`, `views.menus.*` and `views.grid.*`; a string `@viewkitjs/fields` already keys
|
|
73
|
+
stays a fields message. `messages` defaults to `resolveViewsMessage`, the package's English. With
|
|
74
|
+
next-intl, scope the translator to the namespace (`useTranslations("views")`; a root translator over a
|
|
75
|
+
typed catalog can overflow TypeScript) and read each key without its `views.` prefix:
|
|
76
|
+
`(m) => { const key = m.key.slice("views.".length); return t.has(key) ? t(key, "values" in m ? m.values : undefined) : resolveViewsMessage(m); }`.
|
|
77
|
+
|
|
78
|
+
The atoms — `List`, `Row`, `RowContent`, `TickBox`, `StatusBadge`, `StatusMarker`, `Tag`, `CommandMenu`,
|
|
79
|
+
`RelationLink`, `Loading`, `LoadMore`, `PlatformMark`, `RowMenu` — ship as defaults drawn from your theme. Swap any of them through `atoms` so the views wear
|
|
80
|
+
your own menus and pills. `CommandMenu`, `RowMenu` and `RelationLink` are your app's own pieces — the verb menu a
|
|
81
|
+
command cell opens, the row's right-click menu, and where a relation chip goes; their defaults are the map's menu,
|
|
82
|
+
the map's menu at the pointer (its Delete asks the `confirm` port, the browser's own confirm when you hand none), and a chip that goes nowhere. `Loading` and `LoadMore` are your waits — the list reloading, and how it asks for more rows; their
|
|
83
|
+
defaults are a plain ring and a sentinel past the last row. `PlatformMark` is a link's platform, drawn before
|
|
84
|
+
it: the package ships no brand art, so its default draws nothing and a link looks plain; you draw your own
|
|
85
|
+
marks by `platform.key`.
|
|
86
|
+
The field display is `@viewkitjs/views/display`; the editors are `@viewkitjs/views/editors/<name>`, each
|
|
87
|
+
drawn through the map and the atoms — your app hosts them (the popover, the anchor, the write) and never
|
|
88
|
+
writes one. A place's editor is `editors/location` (the country first, then its parts, a region from its list; its
|
|
89
|
+
28 `views.editors.place-*` words are yours to translate). Several emails, phones, links or domains edit in
|
|
90
|
+
`editors/value-list` (a row each: the value, its label, a main mark), committed as one list; bind `labels: false`
|
|
91
|
+
where your row keeps only the values. A name's editor is `editors/name` (given, family and full); its display draws an empty name
|
|
92
|
+
as the words you give it, `nameFallback` in the display options or `nameFallback(row)` on a column.
|
|
93
|
+
|
|
94
|
+
## Draw the grid
|
|
95
|
+
|
|
96
|
+
The grid is `GridTable` from `@viewkitjs/views/grid`. Bind your fields to your rows (`bindFields`), build its
|
|
97
|
+
columns with `columnFrom`, and hand it five props: `groups` (your rows as `ListGroup`s, one group when the list
|
|
98
|
+
is not grouped), `grouped`, `getRowId`, `columns` and `onOpenRow`. An edit reaches your `onCellCommit`
|
|
99
|
+
(`GridCellCommitFn`): map the value through the column binding's `write` and send the body to your API; a
|
|
100
|
+
rejected promise rolls the cell back. Filtering, sorting and grouping the rows (`evaluateView` from
|
|
101
|
+
`@viewkitjs/fields/query`), a person's preferences (`useGridTablePrefs`) and saving are your app's:
|
|
102
|
+
`docs/guides/the-grid.md` walks through each.
|