@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.
Files changed (451) hide show
  1. package/CHANGELOG.md +615 -0
  2. package/LICENSE.md +7 -0
  3. package/README.md +99 -2
  4. package/dist/atoms/CommandMenu.d.ts +2 -0
  5. package/dist/atoms/CommandMenu.js +20 -0
  6. package/dist/atoms/List.d.ts +2 -0
  7. package/dist/atoms/List.js +6 -0
  8. package/dist/atoms/LoadMore.d.ts +2 -0
  9. package/dist/atoms/LoadMore.js +25 -0
  10. package/dist/atoms/Loading.d.ts +2 -0
  11. package/dist/atoms/Loading.js +7 -0
  12. package/dist/atoms/PlatformMark.d.ts +2 -0
  13. package/dist/atoms/PlatformMark.js +4 -0
  14. package/dist/atoms/RelationLink.d.ts +2 -0
  15. package/dist/atoms/RelationLink.js +6 -0
  16. package/dist/atoms/Row.d.ts +3 -0
  17. package/dist/atoms/Row.js +30 -0
  18. package/dist/atoms/RowMenu.d.ts +2 -0
  19. package/dist/atoms/RowMenu.js +112 -0
  20. package/dist/atoms/StatusBadge.d.ts +2 -0
  21. package/dist/atoms/StatusBadge.js +7 -0
  22. package/dist/atoms/StatusMarker.d.ts +2 -0
  23. package/dist/atoms/StatusMarker.js +19 -0
  24. package/dist/atoms/Tag.d.ts +2 -0
  25. package/dist/atoms/Tag.js +13 -0
  26. package/dist/atoms/TickBox.d.ts +2 -0
  27. package/dist/atoms/TickBox.js +8 -0
  28. package/dist/atoms/defaults.d.ts +2 -0
  29. package/dist/atoms/defaults.js +27 -0
  30. package/dist/atoms/tones.d.ts +5 -0
  31. package/dist/atoms/tones.js +28 -0
  32. package/dist/atoms/types.d.ts +178 -0
  33. package/dist/atoms/types.js +3 -0
  34. package/dist/cells/cell-format.d.ts +138 -0
  35. package/dist/cells/cell-format.js +16 -0
  36. package/dist/cells/cell-title.d.ts +17 -0
  37. package/dist/cells/cell-title.js +8 -0
  38. package/dist/cells/cell-values.d.ts +28 -0
  39. package/dist/cells/cell-values.js +87 -0
  40. package/dist/cells/index.d.ts +4 -0
  41. package/dist/cells/index.js +4 -0
  42. package/dist/cells/legacy-field.d.ts +52 -0
  43. package/dist/cells/legacy-field.js +164 -0
  44. package/dist/cells/relation-wrap.d.ts +3 -0
  45. package/dist/cells/relation-wrap.js +24 -0
  46. package/dist/cells/use-cell-format.d.ts +5 -0
  47. package/dist/cells/use-cell-format.js +10 -0
  48. package/dist/contract.d.ts +461 -0
  49. package/dist/contract.js +682 -0
  50. package/dist/display/actor.d.ts +4 -0
  51. package/dist/display/actor.js +26 -0
  52. package/dist/display/boolean.d.ts +18 -0
  53. package/dist/display/boolean.js +43 -0
  54. package/dist/display/breakdown.d.ts +15 -0
  55. package/dist/display/breakdown.js +32 -0
  56. package/dist/display/currency.d.ts +9 -0
  57. package/dist/display/currency.js +29 -0
  58. package/dist/display/date.d.ts +12 -0
  59. package/dist/display/date.js +26 -0
  60. package/dist/display/display-cores.d.ts +31 -0
  61. package/dist/display/display-cores.js +57 -0
  62. package/dist/display/entity-chip.d.ts +26 -0
  63. package/dist/display/entity-chip.js +9 -0
  64. package/dist/display/format.d.ts +66 -0
  65. package/dist/display/format.js +190 -0
  66. package/dist/display/index.d.ts +8 -0
  67. package/dist/display/index.js +7 -0
  68. package/dist/display/link.d.ts +29 -0
  69. package/dist/display/link.js +50 -0
  70. package/dist/display/location.d.ts +8 -0
  71. package/dist/display/location.js +22 -0
  72. package/dist/display/multi-value.d.ts +18 -0
  73. package/dist/display/multi-value.js +28 -0
  74. package/dist/display/name.d.ts +6 -0
  75. package/dist/display/name.js +14 -0
  76. package/dist/display/number.d.ts +11 -0
  77. package/dist/display/number.js +27 -0
  78. package/dist/display/options.d.ts +153 -0
  79. package/dist/display/options.js +1 -0
  80. package/dist/display/percent.d.ts +4 -0
  81. package/dist/display/percent.js +40 -0
  82. package/dist/display/phone.d.ts +11 -0
  83. package/dist/display/phone.js +45 -0
  84. package/dist/display/range.d.ts +6 -0
  85. package/dist/display/range.js +29 -0
  86. package/dist/display/relation.d.ts +4 -0
  87. package/dist/display/relation.js +29 -0
  88. package/dist/display/rich-text.d.ts +10 -0
  89. package/dist/display/rich-text.js +34 -0
  90. package/dist/display/select.d.ts +6 -0
  91. package/dist/display/select.js +38 -0
  92. package/dist/display/text-class.d.ts +23 -0
  93. package/dist/display/text-class.js +5 -0
  94. package/dist/display/text.d.ts +19 -0
  95. package/dist/display/text.js +8 -0
  96. package/dist/display/use-display-options.d.ts +2 -0
  97. package/dist/display/use-display-options.js +14 -0
  98. package/dist/display/user.d.ts +11 -0
  99. package/dist/display/user.js +10 -0
  100. package/dist/display/value-list.d.ts +10 -0
  101. package/dist/display/value-list.js +12 -0
  102. package/dist/display/viewer.d.ts +4 -0
  103. package/dist/display/viewer.js +11 -0
  104. package/dist/display/web-href.d.ts +8 -0
  105. package/dist/display/web-href.js +12 -0
  106. package/dist/editors/ChipsEditor.d.ts +59 -0
  107. package/dist/editors/ChipsEditor.js +73 -0
  108. package/dist/editors/DateEditor.d.ts +25 -0
  109. package/dist/editors/DateEditor.js +122 -0
  110. package/dist/editors/LocationEditor.d.ts +22 -0
  111. package/dist/editors/LocationEditor.js +228 -0
  112. package/dist/editors/NameEditor.d.ts +22 -0
  113. package/dist/editors/NameEditor.js +92 -0
  114. package/dist/editors/NumberEditor.d.ts +67 -0
  115. package/dist/editors/NumberEditor.js +86 -0
  116. package/dist/editors/RangeEditor.d.ts +22 -0
  117. package/dist/editors/RangeEditor.js +70 -0
  118. package/dist/editors/RelationEditor.d.ts +65 -0
  119. package/dist/editors/RelationEditor.js +64 -0
  120. package/dist/editors/SelectEditor.d.ts +72 -0
  121. package/dist/editors/SelectEditor.js +59 -0
  122. package/dist/editors/ValueListEditor.d.ts +38 -0
  123. package/dist/editors/ValueListEditor.js +217 -0
  124. package/dist/editors/edit-cores.d.ts +83 -0
  125. package/dist/editors/edit-cores.js +38 -0
  126. package/dist/editors/edit-session.d.ts +74 -0
  127. package/dist/editors/edit-session.js +35 -0
  128. package/dist/editors/open-values.d.ts +28 -0
  129. package/dist/editors/open-values.js +26 -0
  130. package/dist/editors/relation-source.d.ts +66 -0
  131. package/dist/editors/relation-source.js +102 -0
  132. package/dist/fields/binding.d.ts +87 -0
  133. package/dist/fields/binding.js +117 -0
  134. package/dist/fields/currency.d.ts +82 -0
  135. package/dist/fields/currency.js +41 -0
  136. package/dist/fields/denomination.d.ts +42 -0
  137. package/dist/fields/denomination.js +11 -0
  138. package/dist/fields/edit-core-types.d.ts +40 -0
  139. package/dist/fields/edit-core-types.js +29 -0
  140. package/dist/fields/format-knobs.d.ts +34 -0
  141. package/dist/fields/format-knobs.js +36 -0
  142. package/dist/fields/menus.d.ts +28 -0
  143. package/dist/fields/menus.js +1 -0
  144. package/dist/fields/money.d.ts +60 -0
  145. package/dist/fields/money.js +78 -0
  146. package/dist/fields/number-edit.d.ts +11 -0
  147. package/dist/fields/number-edit.js +17 -0
  148. package/dist/fields/prepare-write.d.ts +55 -0
  149. package/dist/fields/prepare-write.js +67 -0
  150. package/dist/fields/relation-source-types.d.ts +54 -0
  151. package/dist/fields/relation-source-types.js +1 -0
  152. package/dist/figures.d.ts +52 -0
  153. package/dist/figures.js +63 -0
  154. package/dist/filters/date-filter.d.ts +2 -0
  155. package/dist/filters/date-filter.js +1 -0
  156. package/dist/filters/filter-model.d.ts +176 -0
  157. package/dist/filters/filter-model.js +41 -0
  158. package/dist/filters/number-filter.d.ts +2 -0
  159. package/dist/filters/number-filter.js +1 -0
  160. package/dist/filters/range-filter.d.ts +2 -0
  161. package/dist/filters/range-filter.js +1 -0
  162. package/dist/filters/registry.d.ts +103 -0
  163. package/dist/filters/registry.js +8 -0
  164. package/dist/filters/relation-filter.d.ts +16 -0
  165. package/dist/filters/relation-filter.js +53 -0
  166. package/dist/filters/text-filter.d.ts +2 -0
  167. package/dist/filters/text-filter.js +1 -0
  168. package/dist/grid/chrome/GridAddColumn.d.ts +11 -0
  169. package/dist/grid/chrome/GridAddColumn.js +29 -0
  170. package/dist/grid/chrome/GridAggregateMenu.d.ts +31 -0
  171. package/dist/grid/chrome/GridAggregateMenu.js +27 -0
  172. package/dist/grid/chrome/GridCellEditors.d.ts +64 -0
  173. package/dist/grid/chrome/GridCellEditors.js +55 -0
  174. package/dist/grid/chrome/GridCellOutline.d.ts +70 -0
  175. package/dist/grid/chrome/GridCellOutline.js +21 -0
  176. package/dist/grid/chrome/GridChipsEditor.d.ts +28 -0
  177. package/dist/grid/chrome/GridChipsEditor.js +40 -0
  178. package/dist/grid/chrome/GridColumnColorSection.d.ts +11 -0
  179. package/dist/grid/chrome/GridColumnColorSection.js +40 -0
  180. package/dist/grid/chrome/GridColumnDateSection.d.ts +23 -0
  181. package/dist/grid/chrome/GridColumnDateSection.js +23 -0
  182. package/dist/grid/chrome/GridColumnDurationSection.d.ts +19 -0
  183. package/dist/grid/chrome/GridColumnDurationSection.js +24 -0
  184. package/dist/grid/chrome/GridColumnMenu.d.ts +101 -0
  185. package/dist/grid/chrome/GridColumnMenu.js +99 -0
  186. package/dist/grid/chrome/GridColumnNumberSection.d.ts +25 -0
  187. package/dist/grid/chrome/GridColumnNumberSection.js +27 -0
  188. package/dist/grid/chrome/GridColumnPercentSection.d.ts +15 -0
  189. package/dist/grid/chrome/GridColumnPercentSection.js +16 -0
  190. package/dist/grid/chrome/GridColumnSortSection.d.ts +18 -0
  191. package/dist/grid/chrome/GridColumnSortSection.js +16 -0
  192. package/dist/grid/chrome/GridDateEditor.d.ts +22 -0
  193. package/dist/grid/chrome/GridDateEditor.js +31 -0
  194. package/dist/grid/chrome/GridFlyout.d.ts +44 -0
  195. package/dist/grid/chrome/GridFlyout.js +80 -0
  196. package/dist/grid/chrome/GridFooter.d.ts +23 -0
  197. package/dist/grid/chrome/GridFooter.js +81 -0
  198. package/dist/grid/chrome/GridGroupMenu.d.ts +37 -0
  199. package/dist/grid/chrome/GridGroupMenu.js +57 -0
  200. package/dist/grid/chrome/GridHeader.d.ts +61 -0
  201. package/dist/grid/chrome/GridHeader.js +37 -0
  202. package/dist/grid/chrome/GridLongTextEditor.d.ts +36 -0
  203. package/dist/grid/chrome/GridLongTextEditor.js +127 -0
  204. package/dist/grid/chrome/GridMenuRow.d.ts +15 -0
  205. package/dist/grid/chrome/GridMenuRow.js +15 -0
  206. package/dist/grid/chrome/GridNameEditor.d.ts +19 -0
  207. package/dist/grid/chrome/GridNameEditor.js +36 -0
  208. package/dist/grid/chrome/GridNumberEditor.d.ts +35 -0
  209. package/dist/grid/chrome/GridNumberEditor.js +25 -0
  210. package/dist/grid/chrome/GridRangeEditor.d.ts +20 -0
  211. package/dist/grid/chrome/GridRangeEditor.js +25 -0
  212. package/dist/grid/chrome/GridRelationEditor.d.ts +21 -0
  213. package/dist/grid/chrome/GridRelationEditor.js +30 -0
  214. package/dist/grid/chrome/GridResizeHandle.d.ts +19 -0
  215. package/dist/grid/chrome/GridResizeHandle.js +19 -0
  216. package/dist/grid/chrome/GridRow.d.ts +25 -0
  217. package/dist/grid/chrome/GridRow.js +136 -0
  218. package/dist/grid/chrome/GridRowActions.d.ts +32 -0
  219. package/dist/grid/chrome/GridRowActions.js +25 -0
  220. package/dist/grid/chrome/GridRowCells.d.ts +4 -0
  221. package/dist/grid/chrome/GridRowCells.js +133 -0
  222. package/dist/grid/chrome/GridRowGlyph.d.ts +12 -0
  223. package/dist/grid/chrome/GridRowGlyph.js +13 -0
  224. package/dist/grid/chrome/GridSelectEditor.d.ts +18 -0
  225. package/dist/grid/chrome/GridSelectEditor.js +49 -0
  226. package/dist/grid/chrome/GridStructure.d.ts +48 -0
  227. package/dist/grid/chrome/GridStructure.js +45 -0
  228. package/dist/grid/chrome/GridTable.d.ts +4 -0
  229. package/dist/grid/chrome/GridTable.js +125 -0
  230. package/dist/grid/chrome/GridTableSurface.d.ts +15 -0
  231. package/dist/grid/chrome/GridTableSurface.js +6 -0
  232. package/dist/grid/chrome/GridTextEditor.d.ts +11 -0
  233. package/dist/grid/chrome/GridTextEditor.js +40 -0
  234. package/dist/grid/chrome/GridValueListEditor.d.ts +18 -0
  235. package/dist/grid/chrome/GridValueListEditor.js +36 -0
  236. package/dist/grid/chrome/StuckMarker.d.ts +16 -0
  237. package/dist/grid/chrome/StuckMarker.js +34 -0
  238. package/dist/grid/chrome/cell-clipboard.d.ts +9 -0
  239. package/dist/grid/chrome/cell-clipboard.js +28 -0
  240. package/dist/grid/chrome/cells.d.ts +21 -0
  241. package/dist/grid/chrome/cells.js +20 -0
  242. package/dist/grid/chrome/checks.d.ts +35 -0
  243. package/dist/grid/chrome/checks.js +22 -0
  244. package/dist/grid/chrome/column-glyph.d.ts +14 -0
  245. package/dist/grid/chrome/column-glyph.js +44 -0
  246. package/dist/grid/chrome/editors.d.ts +9 -0
  247. package/dist/grid/chrome/editors.js +10 -0
  248. package/dist/grid/chrome/grid-cell-classes.d.ts +59 -0
  249. package/dist/grid/chrome/grid-cell-classes.js +30 -0
  250. package/dist/grid/chrome/grid-menu-search.d.ts +7 -0
  251. package/dist/grid/chrome/grid-menu-search.js +7 -0
  252. package/dist/grid/chrome/grid-row-props.d.ts +131 -0
  253. package/dist/grid/chrome/grid-row-props.js +1 -0
  254. package/dist/grid/chrome/grid-styles.d.ts +37 -0
  255. package/dist/grid/chrome/grid-styles.js +8 -0
  256. package/dist/grid/chrome/grid-table-props.d.ts +173 -0
  257. package/dist/grid/chrome/grid-table-props.js +1 -0
  258. package/dist/grid/chrome/useGridBatchApi.d.ts +34 -0
  259. package/dist/grid/chrome/useGridBatchApi.js +35 -0
  260. package/dist/grid/chrome/useGridColumnLayout.d.ts +30 -0
  261. package/dist/grid/chrome/useGridColumnLayout.js +206 -0
  262. package/dist/grid/chrome/useGridHeaderDrag.d.ts +20 -0
  263. package/dist/grid/chrome/useGridHeaderDrag.js +37 -0
  264. package/dist/grid/chrome/useGridKeyboard.d.ts +47 -0
  265. package/dist/grid/chrome/useGridKeyboard.js +274 -0
  266. package/dist/grid/chrome/useGridPendingReconciliation.d.ts +12 -0
  267. package/dist/grid/chrome/useGridPendingReconciliation.js +32 -0
  268. package/dist/grid/chrome/useGridRailReveal.d.ts +57 -0
  269. package/dist/grid/chrome/useGridRailReveal.js +67 -0
  270. package/dist/grid/chrome/useGridRangeActions.d.ts +49 -0
  271. package/dist/grid/chrome/useGridRangeActions.js +188 -0
  272. package/dist/grid/chrome/useGridRangeGestures.d.ts +32 -0
  273. package/dist/grid/chrome/useGridRangeGestures.js +190 -0
  274. package/dist/grid/chrome/useGridRowContextMenu.d.ts +35 -0
  275. package/dist/grid/chrome/useGridRowContextMenu.js +127 -0
  276. package/dist/grid/chrome/useGridScaleStyles.d.ts +1 -0
  277. package/dist/grid/chrome/useGridScaleStyles.js +29 -0
  278. package/dist/grid/chrome/useGridScrollSync.d.ts +38 -0
  279. package/dist/grid/chrome/useGridScrollSync.js +176 -0
  280. package/dist/grid/chrome/useGridTableInteractionModel.d.ts +55 -0
  281. package/dist/grid/chrome/useGridTableInteractionModel.js +197 -0
  282. package/dist/grid/chrome/useGridTableSelection.d.ts +29 -0
  283. package/dist/grid/chrome/useGridTableSelection.js +55 -0
  284. package/dist/grid/chrome/useHeaderDragReorder.d.ts +21 -0
  285. package/dist/grid/chrome/useHeaderDragReorder.js +216 -0
  286. package/dist/grid/core/clipboard-model.d.ts +81 -0
  287. package/dist/grid/core/clipboard-model.js +291 -0
  288. package/dist/grid/core/column-values.d.ts +27 -0
  289. package/dist/grid/core/column-values.js +76 -0
  290. package/dist/grid/core/commit-model.d.ts +34 -0
  291. package/dist/grid/core/commit-model.js +3 -0
  292. package/dist/grid/core/coordinates.d.ts +48 -0
  293. package/dist/grid/core/coordinates.js +27 -0
  294. package/dist/grid/core/edit-values.d.ts +9 -0
  295. package/dist/grid/core/edit-values.js +1 -0
  296. package/dist/grid/core/editing-controller.d.ts +59 -0
  297. package/dist/grid/core/editing-controller.js +240 -0
  298. package/dist/grid/core/editing-model.d.ts +78 -0
  299. package/dist/grid/core/editing-model.js +136 -0
  300. package/dist/grid/core/grid-scale.d.ts +14 -0
  301. package/dist/grid/core/grid-scale.js +8 -0
  302. package/dist/grid/core/nav.d.ts +94 -0
  303. package/dist/grid/core/nav.js +92 -0
  304. package/dist/grid/core/pending-reconciliation.d.ts +50 -0
  305. package/dist/grid/core/pending-reconciliation.js +49 -0
  306. package/dist/grid/core/range-model.d.ts +25 -0
  307. package/dist/grid/core/range-model.js +59 -0
  308. package/dist/grid/core/spreadsheet-operations.d.ts +85 -0
  309. package/dist/grid/core/spreadsheet-operations.js +253 -0
  310. package/dist/grid/core/useGridEditing.d.ts +43 -0
  311. package/dist/grid/core/useGridEditing.js +90 -0
  312. package/dist/grid/core/useGridRange.d.ts +20 -0
  313. package/dist/grid/core/useGridRange.js +24 -0
  314. package/dist/grid/core/value-equality.d.ts +32 -0
  315. package/dist/grid/core/value-equality.js +34 -0
  316. package/dist/grid/index.d.ts +18 -0
  317. package/dist/grid/index.js +5 -0
  318. package/dist/grid/useGridTablePrefs.d.ts +50 -0
  319. package/dist/grid/useGridTablePrefs.js +101 -0
  320. package/dist/grouping/sort-groups.d.ts +18 -0
  321. package/dist/grouping/sort-groups.js +33 -0
  322. package/dist/grouping/types.d.ts +10 -0
  323. package/dist/grouping/types.js +1 -0
  324. package/dist/index.d.ts +28 -0
  325. package/dist/index.js +28 -0
  326. package/dist/internal/chip.d.ts +4 -0
  327. package/dist/internal/chip.js +3 -0
  328. package/dist/internal/cx.d.ts +3 -0
  329. package/dist/internal/cx.js +3 -0
  330. package/dist/internal/viewport.d.ts +5 -0
  331. package/dist/internal/viewport.js +29 -0
  332. package/dist/model/aggregates.d.ts +59 -0
  333. package/dist/model/aggregates.js +186 -0
  334. package/dist/model/card-density.d.ts +8 -0
  335. package/dist/model/card-density.js +10 -0
  336. package/dist/model/card-layout.d.ts +85 -0
  337. package/dist/model/card-layout.js +90 -0
  338. package/dist/model/column-capabilities.d.ts +162 -0
  339. package/dist/model/column-capabilities.js +233 -0
  340. package/dist/model/column-filters.d.ts +106 -0
  341. package/dist/model/column-filters.js +321 -0
  342. package/dist/model/column-format.d.ts +103 -0
  343. package/dist/model/column-format.js +1 -0
  344. package/dist/model/column-from.d.ts +28 -0
  345. package/dist/model/column-from.js +160 -0
  346. package/dist/model/column-inspect.d.ts +18 -0
  347. package/dist/model/column-inspect.js +6 -0
  348. package/dist/model/column-knobs.d.ts +20 -0
  349. package/dist/model/column-knobs.js +16 -0
  350. package/dist/model/column-money.d.ts +13 -0
  351. package/dist/model/column-money.js +27 -0
  352. package/dist/model/column-order.d.ts +36 -0
  353. package/dist/model/column-order.js +68 -0
  354. package/dist/model/column-schema.d.ts +335 -0
  355. package/dist/model/column-schema.js +1 -0
  356. package/dist/model/column-sort.d.ts +17 -0
  357. package/dist/model/column-sort.js +11 -0
  358. package/dist/model/column-state.d.ts +77 -0
  359. package/dist/model/column-state.js +95 -0
  360. package/dist/model/column-types.d.ts +109 -0
  361. package/dist/model/column-types.js +50 -0
  362. package/dist/model/column-warnings.d.ts +44 -0
  363. package/dist/model/column-warnings.js +24 -0
  364. package/dist/model/density.d.ts +3 -0
  365. package/dist/model/density.js +13 -0
  366. package/dist/model/field-type-of.d.ts +21 -0
  367. package/dist/model/field-type-of.js +11 -0
  368. package/dist/model/filter-capabilities.d.ts +1 -0
  369. package/dist/model/filter-capabilities.js +1 -0
  370. package/dist/model/index.d.ts +38 -0
  371. package/dist/model/index.js +20 -0
  372. package/dist/model/part-rows.d.ts +28 -0
  373. package/dist/model/part-rows.js +40 -0
  374. package/dist/model/preferences.d.ts +155 -0
  375. package/dist/model/preferences.js +84 -0
  376. package/dist/model/prefs-buckets.d.ts +173 -0
  377. package/dist/model/prefs-buckets.js +71 -0
  378. package/dist/model/relation-filters.d.ts +45 -0
  379. package/dist/model/relation-filters.js +78 -0
  380. package/dist/model/render-count.d.ts +2 -0
  381. package/dist/model/render-count.js +24 -0
  382. package/dist/model/row-icon.d.ts +23 -0
  383. package/dist/model/row-icon.js +5 -0
  384. package/dist/model/view-rules.d.ts +73 -0
  385. package/dist/model/view-rules.js +216 -0
  386. package/dist/provider/ViewsProvider.d.ts +26 -0
  387. package/dist/provider/ViewsProvider.js +16 -0
  388. package/dist/provider/components.d.ts +230 -0
  389. package/dist/provider/components.js +3 -0
  390. package/dist/provider/context.d.ts +20 -0
  391. package/dist/provider/context.js +10 -0
  392. package/dist/provider/icons.d.ts +6 -0
  393. package/dist/provider/icons.js +1 -0
  394. package/dist/provider/menu-groups.d.ts +8 -0
  395. package/dist/provider/menu-groups.js +38 -0
  396. package/dist/provider/ports.d.ts +57 -0
  397. package/dist/provider/ports.js +9 -0
  398. package/dist/react.d.ts +9 -0
  399. package/dist/react.js +4 -0
  400. package/dist/selection/SelectCheckbox.d.ts +17 -0
  401. package/dist/selection/SelectCheckbox.js +11 -0
  402. package/dist/selection/index.d.ts +7 -0
  403. package/dist/selection/index.js +6 -0
  404. package/dist/selection/model.d.ts +55 -0
  405. package/dist/selection/model.js +86 -0
  406. package/dist/selection/row-click.d.ts +35 -0
  407. package/dist/selection/row-click.js +20 -0
  408. package/dist/selection/types.d.ts +17 -0
  409. package/dist/selection/types.js +1 -0
  410. package/dist/selection/useCheckDragSelect.d.ts +61 -0
  411. package/dist/selection/useCheckDragSelect.js +165 -0
  412. package/dist/selection/useListSelection.d.ts +39 -0
  413. package/dist/selection/useListSelection.js +48 -0
  414. package/dist/selection/useListSelectionShortcuts.d.ts +6 -0
  415. package/dist/selection/useListSelectionShortcuts.js +14 -0
  416. package/dist/selection/useRestIntent.d.ts +18 -0
  417. package/dist/selection/useRestIntent.js +35 -0
  418. package/docs/contract.md +525 -0
  419. package/docs/getting-started.md +250 -0
  420. package/docs/guides/atoms.md +245 -0
  421. package/docs/guides/cells.md +302 -0
  422. package/docs/guides/columns.md +412 -0
  423. package/docs/guides/display.md +203 -0
  424. package/docs/guides/editors.md +404 -0
  425. package/docs/guides/ports.md +246 -0
  426. package/docs/guides/selection.md +270 -0
  427. package/docs/guides/the-grid.md +677 -0
  428. package/docs/guides/the-provider.md +446 -0
  429. package/docs/index.md +50 -0
  430. package/docs/install.md +67 -0
  431. package/docs/reference/cells.md +28 -0
  432. package/docs/reference/display.md +42 -0
  433. package/docs/reference/editors-chips.md +6 -0
  434. package/docs/reference/editors-date.md +6 -0
  435. package/docs/reference/editors-location.md +10 -0
  436. package/docs/reference/editors-name.md +6 -0
  437. package/docs/reference/editors-number.md +11 -0
  438. package/docs/reference/editors-open-values.md +9 -0
  439. package/docs/reference/editors-range.md +6 -0
  440. package/docs/reference/editors-relation.md +9 -0
  441. package/docs/reference/editors-select.md +8 -0
  442. package/docs/reference/editors-session.md +9 -0
  443. package/docs/reference/editors-value-list.md +6 -0
  444. package/docs/reference/editors.md +5 -0
  445. package/docs/reference/grid.md +39 -0
  446. package/docs/reference/react.md +86 -0
  447. package/docs/reference/selection.md +33 -0
  448. package/docs/reference/views.md +601 -0
  449. package/docs/reshaping.md +19 -0
  450. package/package.json +118 -3
  451. package/skills/views/SKILL.md +102 -0
@@ -0,0 +1,29 @@
1
+ import { type ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ /**
5
+ * THE TWO ADDRESSES — a web address and a mail address. Both are text that goes
6
+ * somewhere; they differ in where, and in how loudly they say so.
7
+ */
8
+ /**
9
+ * A web address. The scheme is stripped from the LABEL and kept in the
10
+ * destination: `https://` is noise in a 240px box and load-bearing in an href.
11
+ * A value that is no link (`webHref`) draws as its text. Its platform
12
+ * (`linkPlatform`, read with the host's conventions) goes to the app's
13
+ * `PlatformMark`, drawn before it; the default draws nothing, so a link looks
14
+ * plain. Several links draw as their main one and a count (`renderValueList`).
15
+ */
16
+ export declare function renderUrl(_field: FieldDefOf<"url">, value: unknown, opts?: DisplayOptions): ReactNode;
17
+ /**
18
+ * A company's domain, labelled as it is kept and linked to `https://` it. A domain is the company's own site,
19
+ * so no platform is read from it: `linkedin.com` kept as a domain is no LinkedIn profile.
20
+ */
21
+ export declare function renderDomain(_field: FieldDefOf<"domain">, value: unknown, opts?: DisplayOptions): ReactNode;
22
+ /**
23
+ * One or several mail addresses.
24
+ *
25
+ * Never the option family's label treatment: an address is not a slug, and
26
+ * title-casing turned `no-reply@vendor.com` into "No Reply@vendor.Com" — a
27
+ * mangled address rather than merely an ugly one.
28
+ */
29
+ export declare function renderEmail(_field: FieldDefOf<"email">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,50 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
+ import { useContext } from "react";
4
+ import { linkPlatform } from "@viewkitjs/fields";
5
+ import { cx } from "../internal/cx.js";
6
+ import { ViewsContext } from "../provider/context.js";
7
+ import { cellTextClass } from "./text-class.js";
8
+ import { renderValueList } from "./value-list.js";
9
+ import { webHref } from "./web-href.js";
10
+ export function renderUrl(_field, value, opts) {
11
+ if (Array.isArray(value))
12
+ return renderValueList(value, (one) => _jsx(WebAddress, { address: String(one), opts: single(opts) }), opts);
13
+ return _jsx(WebAddress, { address: String(value), opts: opts });
14
+ }
15
+ function single(opts) {
16
+ return opts ? { ...opts, wrap: false } : opts;
17
+ }
18
+ function WebAddress({ address, opts }) {
19
+ const views = useContext(ViewsContext);
20
+ const label = address.replace(/^https?:\/\//, "");
21
+ const href = webHref(address);
22
+ const link = opts?.slotOwnsClick || href === null ? (_jsx("span", { className: cellTextClass(opts?.wrap), children: label })) : (_jsx("a", { href: href, target: "_blank", rel: "noopener noreferrer", "data-no-nav": true, className: cx(cellTextClass(opts?.wrap), "text-(color:--vk-fg-brand) hover:underline"), children: label }));
23
+ const platform = views && href !== null ? linkPlatform(address, views.conventions) : null;
24
+ if (!platform || !views)
25
+ return link;
26
+ return (_jsxs("span", { className: "inline-flex max-w-full min-w-0 items-baseline gap-1.5", children: [_jsx(views.atoms.PlatformMark, { platform: platform }), link] }));
27
+ }
28
+ export function renderDomain(_field, value, opts) {
29
+ if (Array.isArray(value))
30
+ return renderValueList(value, (one) => domainLink(String(one), single(opts)), opts);
31
+ return domainLink(String(value), opts);
32
+ }
33
+ function domainLink(domain, opts) {
34
+ const href = webHref(domain);
35
+ if (opts?.slotOwnsClick || href === null)
36
+ return _jsx("span", { className: cellTextClass(opts?.wrap), children: domain });
37
+ return (_jsx("a", { href: href, target: "_blank", rel: "noopener noreferrer", "data-no-nav": true, className: cx(cellTextClass(opts?.wrap), "text-(color:--vk-fg-brand) hover:underline"), children: domain }));
38
+ }
39
+ export function renderEmail(_field, value, opts) {
40
+ if (Array.isArray(value))
41
+ return renderValueList(value, (one) => renderEmailAddress(String(one), opts), opts);
42
+ if (value == null || value === "")
43
+ return null;
44
+ return renderValueList([value], (one) => renderEmailAddress(String(one), opts), opts);
45
+ }
46
+ function renderEmailAddress(address, opts) {
47
+ if (opts?.slotOwnsClick)
48
+ return _jsx("span", { children: address });
49
+ return (_jsx("a", { href: `mailto:${address}`, "data-no-nav": true, className: "text-(color:--vk-fg) underline decoration-dotted decoration-(color:--vk-fg-subtle)/40 decoration-1 underline-offset-[3px] transition-colors hover:decoration-(color:--vk-fg-subtle)/60", onClick: (event) => event.stopPropagation(), children: address }));
50
+ }
@@ -0,0 +1,8 @@
1
+ import { type FieldDefOf } from "@viewkitjs/fields";
2
+ import type { DisplayOptions } from "./options.js";
3
+ /** A place remains structured until the display boundary, then reads as one line. A cell draws it short, its city
4
+ * and its country (`locationShort`); a host with room for the whole value (`wrap: "full"`) draws the whole place
5
+ * (`locationText`). The country is named in the viewer's language: the host's viewer, else the provider's
6
+ * conventions, as the place editor names it (VK-120). A list of places (a lookup through a many relation, VK-63)
7
+ * draws through the several-values layout, each place written so. */
8
+ export declare function renderLocation(field: FieldDefOf<"location">, value: unknown, opts?: DisplayOptions): import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,22 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { locationShort, locationText } from "@viewkitjs/fields";
4
+ import { MultiValueCell } from "./multi-value.js";
5
+ import { useDisplayOptions } from "./use-display-options.js";
6
+ export function renderLocation(field, value, opts) {
7
+ void field;
8
+ const write = opts?.wrap === "full" ? locationText : locationShort;
9
+ if (Array.isArray(value) ? !value.some((place) => write(place)) : !write(value))
10
+ return null;
11
+ return _jsx(PlaceValue, { value: value, opts: opts });
12
+ }
13
+ function PlaceValue({ value, opts: given }) {
14
+ const opts = useDisplayOptions(given);
15
+ const write = opts.wrap === "full" ? locationText : locationShort;
16
+ const locale = opts.viewer?.locale;
17
+ if (Array.isArray(value)) {
18
+ const places = value.map((place) => write(place, locale)).filter(Boolean);
19
+ return (_jsx(MultiValueCell, { items: places, wrap: !!opts.wrap, title: places.join(", "), slotOwnsClick: opts.slotOwnsClick }));
20
+ }
21
+ return write(value, locale);
22
+ }
@@ -0,0 +1,18 @@
1
+ import { type ReactNode } from "react";
2
+ export declare function MultiValueCell({ items, details, wrap, title, slotOwnsClick, }: {
3
+ /** One rendered node per value, in order. Each is drawn by its TYPE's item
4
+ * renderer, and the same nodes are reused in the popover — so an address
5
+ * stays a `mailto:` and a relation chip still opens its own entity. */
6
+ items: ReactNode[];
7
+ /** One word per value drawn beside it in the popover (a value's label), never in the cell. */
8
+ details?: (string | null)[];
9
+ /** The user's "Wrap columns" toggle. BINARY here, unlike `DisplayOptions.wrap`
10
+ * — a chip list either flows onto more rows or does not; there is no
11
+ * uncapped state to ask for, because the overflow is a count, not a clip. */
12
+ wrap?: boolean;
13
+ /** The whole set as plain text, for the native hover. */
14
+ title?: string;
15
+ /** A host whose own slot owns the click (see `DisplayOptions`) — the overflow
16
+ * count draws as plain text, and mounts no popover at all. */
17
+ slotOwnsClick?: boolean;
18
+ }): import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,28 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
3
+ import { useRef, useState } from "react";
4
+ import { cx } from "../internal/cx.js";
5
+ import { useViews } from "../provider/context.js";
6
+ const VISIBLE_FLAT = 1;
7
+ const VISIBLE_WRAPPED = 3;
8
+ const ROW_INSET = 14;
9
+ export function MultiValueCell({ items, details, wrap, title, slotOwnsClick, }) {
10
+ const { atoms, components, messages } = useViews();
11
+ const [open, setOpen] = useState(false);
12
+ const anchor = useRef(null);
13
+ const trigger = useRef(null);
14
+ if (items.length === 0)
15
+ return null;
16
+ const shown = items.slice(0, wrap ? VISIBLE_WRAPPED : VISIBLE_FLAT);
17
+ const hidden = items.length - shown.length;
18
+ const content = (_jsxs("span", { ref: anchor, className: cx("flex min-w-0 items-center gap-1", wrap && "flex-wrap gap-y-0.5"), title: title, children: [shown.map((item, index) => (_jsx("span", { className: "flex min-w-0 items-center truncate", children: item }, index))), hidden > 0 &&
19
+ (slotOwnsClick ? (_jsxs("span", { className: "shrink-0 text-[10px] leading-[0.9rem] text-(color:--vk-fg-subtle)", children: ["+", hidden] })) : (_jsxs("button", { ref: trigger, type: "button", tabIndex: -1, "data-no-nav": true, "aria-label": messages({ key: "views.display.show-all", values: { count: items.length } }), "aria-haspopup": "dialog", "aria-expanded": open, onClick: (event) => {
20
+ event.stopPropagation();
21
+ setOpen((current) => !current);
22
+ }, className: cx("shrink-0 rounded-md [corner-shape:squircle] border border-(color:--vk-border)", "bg-(color:--vk-ground) px-1 text-[10px] leading-[0.9rem] text-(color:--vk-fg-subtle) shadow-xs", "transition-colors hover:bg-(color:--vk-hovered) hover:text-(color:--vk-fg)"), children: ["+", hidden] })))] }));
23
+ if (hidden === 0 || slotOwnsClick)
24
+ return content;
25
+ const { Popover } = components;
26
+ const { List, Row } = atoms;
27
+ return (_jsxs(_Fragment, { children: [content, _jsx(Popover, { open: open, onOpenChange: (next) => setOpen(next), anchor: anchor, side: "bottom", align: "start", sideOffset: 4, alignOffset: -(ROW_INSET + 1), chrome: "menu", className: "w-72", onPanelClick: (event) => event.stopPropagation(), onOutsidePress: (event) => (trigger.current?.contains(event.target) ? false : undefined), children: _jsx(List, { className: "max-h-72 overflow-y-auto overscroll-contain scrollbar-overlay", children: items.map((item, index) => (_jsx(Row, { interactive: false, wrap: true, size: "compact", label: item, trailing: details?.[index] ? (_jsx("span", { className: "shrink-0 text-xs text-(color:--vk-fg-subtle)", children: details[index] })) : undefined }, index))) }) })] }));
28
+ }
@@ -0,0 +1,6 @@
1
+ import { type FieldDefOf } from "@viewkitjs/fields";
2
+ import type { DisplayOptions } from "./options.js";
3
+ /** A name reads as the person writes it: the full name, else the given and family names (`nameText`), else
4
+ * the words the host gives an empty name (`nameFallback`, an email say), else nothing. A list of names (a lookup
5
+ * through a many relation, VK-63) draws through the several-values layout, each name written so. */
6
+ export declare function renderName(field: FieldDefOf<"name">, value: unknown, opts?: DisplayOptions): string | import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,14 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { nameText } from "@viewkitjs/fields";
4
+ import { MultiValueCell } from "./multi-value.js";
5
+ export function renderName(field, value, opts) {
6
+ void field;
7
+ if (Array.isArray(value)) {
8
+ const names = value.map(nameText).filter(Boolean);
9
+ if (names.length === 0)
10
+ return opts?.nameFallback || null;
11
+ return (_jsx(MultiValueCell, { items: names, wrap: !!opts?.wrap, title: names.join(", "), slotOwnsClick: opts?.slotOwnsClick }));
12
+ }
13
+ return nameText(value) || opts?.nameFallback || null;
14
+ }
@@ -0,0 +1,11 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ /**
5
+ * A number — plain or duration, the two readings a NUMBER still has. Money and
6
+ * percentages left for cores of their own (`currency.tsx`, `percent.tsx`).
7
+ *
8
+ * A value that isn't a number at all renders as itself — the same honesty the
9
+ * date core shows an unparseable date.
10
+ */
11
+ export declare function renderNumber(field: FieldDefOf<"number">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,27 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
+ import { bandTone, isIntegerField } from "@viewkitjs/fields";
4
+ import { STATUS_TEXT } from "../atoms/tones.js";
5
+ import { cx } from "../internal/cx.js";
6
+ import { CellSuffix, formatNumberValue } from "./format.js";
7
+ import { cellTextClass } from "./text-class.js";
8
+ import { useDisplayOptions } from "./use-display-options.js";
9
+ export function renderNumber(field, value, opts) {
10
+ const n = typeof value === "number" ? value : Number(value);
11
+ if (Number.isNaN(n))
12
+ return _jsx("span", { className: cellTextClass(opts?.wrap), children: String(value) });
13
+ return _jsx(NumberValue, { field: field, n: n, opts: opts });
14
+ }
15
+ function NumberValue({ field, n, opts: given }) {
16
+ const opts = useDisplayOptions(given);
17
+ const format = field.format;
18
+ const signed = format && "signed" in format ? format.signed : undefined;
19
+ const signedTone = format && "signedTone" in format ? format.signedTone : undefined;
20
+ const suffix = format && "suffix" in format ? format.suffix : undefined;
21
+ const bands = format && "bands" in format ? format.bands : undefined;
22
+ const plainDecimals = format && "decimals" in format ? format.decimals : undefined;
23
+ const integer = isIntegerField(field);
24
+ const shown = integer ? { ...opts, decimals: 0 } : opts;
25
+ const tone = bandTone(bands, n, integer ? 0 : (opts?.decimals ?? plainDecimals ?? 2));
26
+ return (_jsxs("span", { className: cx(cellTextClass(opts?.wrap), "tabular-nums", tone ? STATUS_TEXT[tone] : signed && signedTone !== "neutral" && n > 0 && STATUS_TEXT.success), children: [formatNumberValue(n, format, shown), suffix && _jsx(CellSuffix, { children: suffix })] }));
27
+ }
@@ -0,0 +1,153 @@
1
+ import type { ReactNode } from "react";
2
+ import type { CategoryColor } from "@viewkitjs/fields/design/category-colors";
3
+ import type { CurrencyFormat, DateStyle, FieldMessageResolver, NumberFormat, PercentDisplay, PercentFormat, RelationValue } from "@viewkitjs/fields";
4
+ import type { DurationStyle } from "@viewkitjs/fields/format/time";
5
+ import type { ViewsMessageResolver } from "../contract.js";
6
+ /**
7
+ * What the number FORMATTER accepts — wider than what a number FIELD declares.
8
+ *
9
+ * `percent` and `currency` are types now, not number styles, so `NumberFormat`
10
+ * no longer names them. The formatter still has to print all three, because a
11
+ * footer sum, a column menu's live preview and the three display cores all
12
+ * reach one string function: the two typed cores fold their field's format into
13
+ * this shape (`{ style: "percent", decimals }`) and hand it over.
14
+ */
15
+ export type NumberLikeFormat = NumberFormat | ({
16
+ style: "percent";
17
+ } & PercentFormat) | ({
18
+ style: "currency";
19
+ currency?: string;
20
+ } & CurrencyFormat);
21
+ /**
22
+ * WHAT A FIELD CANNOT KNOW.
23
+ *
24
+ * A `FieldDef` describes the value: its type, its vocabulary, how it presents.
25
+ * Everything else a renderer needs comes from the surface drawing it — the row
26
+ * this value sits on (its currency), the user's per-column overrides (a date
27
+ * style, a decimals count), the host's own chrome (where a relation chip goes,
28
+ * whether the slot already owns the click). Those arrive here, so a core takes
29
+ * two arguments and stays portable: the field, and the answers.
30
+ *
31
+ * Everything is optional on purpose. `renderFieldValue(field, value)` with no
32
+ * options at all is a legal call and draws the field's own defaults — that is
33
+ * what makes a core liftable into a surface that has no list underneath it.
34
+ */
35
+ /**
36
+ * How a host wraps ONE relation chip with its own click-through.
37
+ *
38
+ * The core draws the identity — avatar/icon + label — and nothing else, because
39
+ * where a chip GOES is not a property of the field: the grid resolves the
40
+ * entity's drawer from this app's registry, the detail panel opens its own
41
+ * stack, and a calendar card wants no click at all. Each host supplies the
42
+ * verb; the identity inside stays one object.
43
+ */
44
+ export type RelationWrap = (relation: RelationValue, chip: ReactNode) => ReactNode;
45
+ /** Viewer-owned context. No mutable locale or timezone singleton lives in fields. */
46
+ export type FieldViewerContext = {
47
+ locale: string;
48
+ timeZone?: string;
49
+ /** The viewer's country, from the conventions: a phone of that country is written as at home. */
50
+ region?: string;
51
+ now: Date;
52
+ /** Fields' own words (`time.ago`). Default: fields' English. */
53
+ fieldMessages?: FieldMessageResolver;
54
+ /** The views package's words (`views.display.*`). Default: the package's English. */
55
+ messages?: ViewsMessageResolver;
56
+ };
57
+ /** Complete host presentation seam; Phase 4 routes every formatter through it. */
58
+ export type FieldPresentation = {
59
+ message: FieldMessageResolver;
60
+ number: (input: {
61
+ value: number;
62
+ format?: NumberLikeFormat;
63
+ decimals?: number;
64
+ currency?: string;
65
+ context: FieldViewerContext;
66
+ }) => string;
67
+ duration: (input: {
68
+ milliseconds: number;
69
+ style?: DurationStyle;
70
+ context: FieldViewerContext;
71
+ }) => string;
72
+ calendarDay: (input: {
73
+ day: string;
74
+ style: Exclude<DateStyle, "relative">;
75
+ context: FieldViewerContext;
76
+ }) => string;
77
+ instant: (input: {
78
+ instant: string | Date;
79
+ style: Exclude<DateStyle, "relative">;
80
+ withTime: boolean;
81
+ context: FieldViewerContext;
82
+ }) => string;
83
+ relativeCalendarDay: (input: {
84
+ day: string;
85
+ context: FieldViewerContext;
86
+ }) => string;
87
+ relativeInstant: (input: {
88
+ instant: string | Date;
89
+ context: FieldViewerContext;
90
+ }) => string;
91
+ };
92
+ export type DisplayOptions = {
93
+ /** Complete host-supplied formatting and message implementation. */
94
+ presentation?: FieldPresentation;
95
+ /** Immutable viewer inputs supplied alongside a presentation implementation. */
96
+ viewer?: FieldViewerContext;
97
+ /** select: per-user colour overrides (a list preference) — resolved by the caller. */
98
+ optionColors?: Record<string, CategoryColor>;
99
+ /**
100
+ * select/multiselect: the LIST's pre-registry label rule for a value no option
101
+ * names. Absent, a stray value renders as the muted "unknown" chip (fields' docs/guides/options.md)
102
+ * — a registry field never invents a label for a code its vocabulary refuses.
103
+ */
104
+ labelFallback?: (value: string) => string;
105
+ dateStyle?: DateStyle;
106
+ durationStyle?: DurationStyle;
107
+ decimals?: number;
108
+ /** currency: the code this VALUE is in — resolved by the caller, which has the row. */
109
+ currency?: string;
110
+ /** name: the words drawn for an empty name — resolved by the caller, which has the row (an email, say). */
111
+ nameFallback?: string;
112
+ /** date: the per-user show-time override — wins over the field's `withTime`. */
113
+ withTime?: boolean;
114
+ /** percent: the workspace's display choice — wins over the field's `format.display`. */
115
+ percentDisplay?: PercentDisplay;
116
+ /**
117
+ * The "wrap" toggle: text-bearing values clamp to three lines instead of
118
+ * truncating. `"full"` is the third state — the whole value, newlines kept,
119
+ * no cap — which only a host with room asks for (`FieldRow`, for a
120
+ * `format.long` text field). See `cellTextClass`.
121
+ */
122
+ wrap?: boolean | "full";
123
+ /** boolean `icon` style: the two-state glyph. A node, so it cannot live on the field. */
124
+ booleanIcon?: (on: boolean) => ReactNode;
125
+ /** boolean `marker`: the badge's words. Falls back to the field's own label. */
126
+ marker?: {
127
+ label?: string;
128
+ title?: string;
129
+ };
130
+ /** boolean `marker`: this row's reason sentence. */
131
+ markerReason?: string | null;
132
+ /** boolean `marker`: clear the exception — the one-way `true → false` verb. */
133
+ onResolve?: () => void;
134
+ /**
135
+ * Two-way (`checkbox` / `icon`) booleans: flip the value. Its
136
+ * PRESENCE is the affordance — without it the display draws a plain,
137
+ * unclickable glyph, which is what a read-only or locked field looks like.
138
+ */
139
+ onToggle?: (next: boolean) => void;
140
+ /** Temporarily disables a two-way control while preserving its rendered shape. */
141
+ booleanDisabled?: boolean;
142
+ /** relation: the caller's glyph for a kind. The field core has no app registry. */
143
+ entityIcon?: (kind: string | undefined) => ReactNode;
144
+ /** relation: the caller wraps each chip with its own click-through. Absent = inert. */
145
+ relationWrap?: RelationWrap;
146
+ /**
147
+ * A host whose own slot already owns the click and the drag — a calendar event
148
+ * card, whose outer element is the button. Every core draws its bare content:
149
+ * an overflow count is plain text with no popover trigger, a two-way boolean
150
+ * shows its glyph with no toggle. Set once by the host, never per field.
151
+ */
152
+ slotOwnsClick?: boolean;
153
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,4 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ export declare function renderPercent(field: FieldDefOf<"percent">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,40 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
+ import { bandTone, isIntegerField } from "@viewkitjs/fields";
4
+ import { STATUS_TEXT } from "../atoms/tones.js";
5
+ import { cx } from "../internal/cx.js";
6
+ import { CellSuffix, formatNumberValue } from "./format.js";
7
+ import { cellTextClass } from "./text-class.js";
8
+ import { useDisplayOptions } from "./use-display-options.js";
9
+ const RING_MASK = "radial-gradient(farthest-side, transparent calc(100% - 3.5px), #000 calc(100% - 3px))";
10
+ export function renderPercent(field, value, opts) {
11
+ const n = typeof value === "number" ? value : Number(value);
12
+ if (Number.isNaN(n))
13
+ return _jsx("span", { className: cellTextClass(opts?.wrap), children: String(value) });
14
+ return _jsx(PercentValue, { field: field, n: n, opts: opts });
15
+ }
16
+ function PercentValue({ field, n, opts: given }) {
17
+ const opts = useDisplayOptions(given);
18
+ const decimals = isIntegerField(field) ? 0 : (opts?.decimals ?? field.format?.decimals ?? 0);
19
+ const figure = formatNumberValue(n, { style: "plain", decimals }, { ...opts, decimals });
20
+ const tone = bandTone(field.format?.bands, n, decimals);
21
+ const toneClass = tone ? STATUS_TEXT[tone] : undefined;
22
+ const display = opts?.percentDisplay ?? field.format?.display ?? "text";
23
+ if (display === "text") {
24
+ return (_jsxs("span", { className: cx(cellTextClass(opts?.wrap), "tabular-nums", toneClass), children: [figure, _jsx(CellSuffix, { children: "%" })] }));
25
+ }
26
+ const clamped = Math.max(0, Math.min(100, n));
27
+ const figureSlot = `calc(${3 + decimals + (decimals > 0 ? 0.5 : 0) + 1.25}ch + 0.25rem)`;
28
+ const figureRoom = "calc(100% + var(--vk-px, 0px))";
29
+ const figureNode = (bar) => (_jsxs("span", { className: cx("shrink-0 text-right tabular-nums", bar && "truncate", toneClass), style: bar
30
+ ? { width: "max-content", minWidth: `min(${figureSlot}, ${figureRoom})`, maxWidth: figureRoom }
31
+ : { width: figureSlot }, children: [figure, _jsx(CellSuffix, { children: "%" })] }));
32
+ if (display === "bar") {
33
+ return (_jsxs("span", { className: "flex h-lh w-full min-w-0 flex-1 flex-row-reverse flex-wrap content-start items-center gap-x-2 overflow-y-clip", style: { maxWidth: `calc(6rem + 0.5rem + ${figureSlot})` }, children: [figureNode(true), _jsx("span", { className: "h-1.5 min-w-6 flex-1 overflow-hidden rounded-full bg-(color:--vk-neutral)", "aria-hidden": true, children: _jsx("span", { className: "block h-full bg-(color:--vk-brand)", style: { width: `${clamped}%` } }) })] }));
34
+ }
35
+ return (_jsxs("span", { className: "flex min-w-0 items-center gap-2", children: [_jsx("span", { className: "h-4 w-4 shrink-0 rounded-full", style: {
36
+ background: `conic-gradient(var(--vk-brand) ${clamped}%, var(--vk-neutral) 0)`,
37
+ WebkitMaskImage: RING_MASK,
38
+ maskImage: RING_MASK,
39
+ }, "aria-hidden": true }), figureNode(false)] }));
40
+ }
@@ -0,0 +1,11 @@
1
+ import type { ReactNode } from "react";
2
+ import type { FieldDefOf } from "@viewkitjs/fields/types";
3
+ import type { DisplayOptions } from "./options.js";
4
+ /**
5
+ * A phone in its international form, written the way its country writes it for a viewer at home (the viewer's
6
+ * region, from the conventions) and internationally for anyone else, its extension in the package's words after
7
+ * it, dialled by its RFC 3966 link. A phone stored as typed, before phones had one form, is drawn as before (its
8
+ * text, a link of its digits and a leading `+`) and flagged as not yet in the international form. The viewer is
9
+ * the host's, else the provider's conventions and words (VK-120).
10
+ */
11
+ export declare function renderPhone(_field: FieldDefOf<"phone">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,45 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { phoneHref, phoneText, readPhone } from "@viewkitjs/fields/phone";
4
+ import { resolveViewsMessage } from "../contract.js";
5
+ import { cx } from "../internal/cx.js";
6
+ import { CHIP_INTERACTIVE } from "../internal/chip.js";
7
+ import { cellTextClass } from "./text-class.js";
8
+ import { useDisplayOptions } from "./use-display-options.js";
9
+ import { renderValueList } from "./value-list.js";
10
+ export function renderPhone(_field, value, opts) {
11
+ if (!Array.isArray(value) && !readPhone(value))
12
+ return null;
13
+ return _jsx(PhoneValue, { value: value, opts: opts });
14
+ }
15
+ function PhoneValue({ value, opts: given }) {
16
+ const opts = useDisplayOptions(given);
17
+ if (Array.isArray(value))
18
+ return renderValueList(value, (one) => phoneNode(one, { ...opts, wrap: false }), opts, (one) => phoneLine(one, opts) ?? String(one));
19
+ return phoneNode(value, opts);
20
+ }
21
+ function phoneLine(value, opts) {
22
+ const reading = readPhone(value);
23
+ if (!reading)
24
+ return null;
25
+ if (reading.kind !== "international")
26
+ return reading.text;
27
+ const words = opts?.viewer?.messages ?? resolveViewsMessage;
28
+ const { extension } = reading.value;
29
+ const number = phoneText({ ...reading.value, extension: null }, opts?.viewer?.region);
30
+ return extension ? `${number} ${words({ key: "views.display.phone-extension", values: { extension } })}` : number;
31
+ }
32
+ function phoneNode(value, opts) {
33
+ const reading = readPhone(value);
34
+ if (!reading)
35
+ return null;
36
+ const words = opts?.viewer?.messages ?? resolveViewsMessage;
37
+ const text = phoneLine(value, opts) ?? "";
38
+ const asTyped = reading.kind === "international"
39
+ ? undefined
40
+ : { "data-as-typed": "", title: words({ key: "views.display.phone-as-typed" }) };
41
+ if (opts?.slotOwnsClick) {
42
+ return (_jsx("span", { className: cellTextClass(opts?.wrap), ...asTyped, children: text }));
43
+ }
44
+ return (_jsx("a", { href: phoneHref(value) ?? undefined, "data-no-nav": true, className: cx(cellTextClass(opts?.wrap), CHIP_INTERACTIVE), onClick: (event) => event.stopPropagation(), ...asTyped, children: text }));
45
+ }
@@ -0,0 +1,6 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ /** A low and a high end — "11–50", "10,001+", "up to 50" — then the code and
5
+ * the period of an amount range. */
6
+ export declare function renderRange(field: FieldDefOf<"range">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,29 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
+ import { rangeText } from "@viewkitjs/fields";
4
+ import { useViews } from "../provider/context.js";
5
+ import { CellSuffix } from "./format.js";
6
+ import { cellTextClass } from "./text-class.js";
7
+ const PERIOD_SHORT = {
8
+ hour: "/h",
9
+ day: "/day",
10
+ week: "/wk",
11
+ month: "/mo",
12
+ year: "/yr",
13
+ };
14
+ export function renderRange(field, value, opts) {
15
+ return _jsx(RangeValueCell, { field: field, value: value, opts: opts });
16
+ }
17
+ function RangeValueCell({ field, value, opts, }) {
18
+ const { conventions } = useViews();
19
+ const text = rangeText(field, value, conventions);
20
+ if (!text)
21
+ return null;
22
+ const unit = field.of === "percent"
23
+ ? "%"
24
+ : field.of === "currency"
25
+ ? field.code?.fixed
26
+ : field.format?.suffix;
27
+ const period = field.period ? PERIOD_SHORT[field.period] : undefined;
28
+ return (_jsxs("span", { className: cellTextClass(opts?.wrap), title: text, children: [_jsx("span", { className: "tabular-nums", children: text }), unit && _jsx(CellSuffix, { children: unit }), period && _jsx(CellSuffix, { children: period })] }));
29
+ }
@@ -0,0 +1,4 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ export declare function renderRelation(field: FieldDefOf<"relation">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,29 @@
1
+ "use client";
2
+ import { jsx as _jsx } from "react/jsx-runtime";
3
+ import { orderLinks, relationKinds, resolveRelationValue, } from "@viewkitjs/fields";
4
+ import { CHIP_BASE } from "../internal/chip.js";
5
+ import { useViews } from "../provider/context.js";
6
+ import { EntityChipIdentity } from "./entity-chip.js";
7
+ import { MultiValueCell } from "./multi-value.js";
8
+ import { cellTextClass } from "./text-class.js";
9
+ export function renderRelation(field, value, opts) {
10
+ if (Array.isArray(value)) {
11
+ const chips = orderLinks(field, value
12
+ .map((entry) => resolveRelationValue(entry, relationKinds(field)[0]))
13
+ .filter((entry) => entry != null));
14
+ if (chips.length === 0)
15
+ return null;
16
+ return (_jsx(MultiValueCell, { items: chips.map((chip) => _jsx(RelationChip, { relation: chip, opts: opts }, `${chip.entity ?? ""}:${chip.id}`)), wrap: !!opts?.wrap, title: chips.map((chip) => chip.label).join(", "), slotOwnsClick: opts?.slotOwnsClick }));
17
+ }
18
+ const relation = resolveRelationValue(value, relationKinds(field)[0]);
19
+ if (!relation)
20
+ return null;
21
+ return _jsx(RelationChip, { relation: relation, opts: opts });
22
+ }
23
+ function RelationChip({ relation, opts }) {
24
+ const Glyph = useViews().icons.relation;
25
+ const chip = (_jsx(EntityChipIdentity, { label: relation.label, avatarUrl: relation.avatarUrl, iconOverride: relation.icon ?? opts?.entityIcon?.(relation.entity), fallbackIcon: _jsx(Glyph, { className: "h-3 w-3 shrink-0 text-(color:--vk-fg-subtlest)" }), labelClassName: cellTextClass(opts?.wrap) }));
26
+ if (opts?.relationWrap)
27
+ return opts.relationWrap(relation, chip);
28
+ return (_jsx("span", { className: CHIP_BASE, title: relation.label, children: chip }));
29
+ }
@@ -0,0 +1,10 @@
1
+ import { type ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ /**
5
+ * Markdown, drawn three ways by how much room the surface has. One line: the
6
+ * first line with words, stripped. Wrapped (a card, a wrapped grid): the plain
7
+ * lines, clamped. `"full"` (a drawer row): the app's own renderer, folded past a
8
+ * height with Show more.
9
+ */
10
+ export declare function renderRichText(_field: FieldDefOf<"rich_text">, value: unknown, opts?: DisplayOptions): ReactNode;
@@ -0,0 +1,34 @@
1
+ "use client";
2
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
3
+ import { useLayoutEffect, useRef, useState } from "react";
4
+ import { markdownFirstLine, markdownPlainText } from "@viewkitjs/fields";
5
+ import { cx } from "../internal/cx.js";
6
+ import { useViews } from "../provider/context.js";
7
+ import { cellTextClass } from "./text-class.js";
8
+ const FOLDED_PX = 160;
9
+ export function renderRichText(_field, value, opts) {
10
+ const text = String(value);
11
+ if (opts?.wrap === "full")
12
+ return _jsx(RichTextBlock, { source: text });
13
+ if (opts?.wrap) {
14
+ return (_jsx("span", { className: cx(cellTextClass(true), "whitespace-pre-line"), children: markdownPlainText(text) }));
15
+ }
16
+ const line = markdownFirstLine(text);
17
+ return (_jsx("span", { className: cellTextClass(false), title: line, children: line }));
18
+ }
19
+ function RichTextBlock({ source }) {
20
+ const { components, messages } = useViews();
21
+ const { Markdown } = components;
22
+ const boxRef = useRef(null);
23
+ const [tall, setTall] = useState(false);
24
+ const [open, setOpen] = useState(false);
25
+ useLayoutEffect(() => {
26
+ const el = boxRef.current;
27
+ if (el)
28
+ setTall(el.scrollHeight > FOLDED_PX + 8);
29
+ }, [source]);
30
+ return (_jsxs("div", { className: "min-w-0", children: [_jsxs("div", { ref: boxRef, className: cx("relative min-w-0 overflow-hidden", !open && tall && "max-h-40"), children: [_jsx(Markdown, { source: source }), !open && tall && (_jsx("div", { className: "pointer-events-none absolute inset-x-0 bottom-0 h-10 bg-linear-to-t from-(color:--vk-ground) to-transparent" }))] }), tall && (_jsx("button", { type: "button", "data-no-nav": true, onClick: (event) => {
31
+ event.stopPropagation();
32
+ setOpen((was) => !was);
33
+ }, className: "mt-1 text-xs text-(color:--vk-fg-subtle) hover:text-(color:--vk-fg)", children: messages({ key: open ? "views.display.show-less" : "views.display.show-more" }) }))] }));
34
+ }
@@ -0,0 +1,6 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldDefOf } from "@viewkitjs/fields";
3
+ import type { DisplayOptions } from "./options.js";
4
+ export declare function renderSelect(field: FieldDefOf<"select">, value: unknown, opts?: DisplayOptions): ReactNode;
5
+ export declare function renderStatus(field: FieldDefOf<"status">, value: unknown, opts?: DisplayOptions): ReactNode;
6
+ export declare function renderMultiselect(field: FieldDefOf<"multiselect">, value: unknown, opts?: DisplayOptions): ReactNode;