ui-sdk-table-vue 0.2.1 → 0.2.2
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/docs/cell-editing.md +3 -4
- package/docs/cells-and-slots.md +3 -2
- package/docs/controller-and-view.md +3 -1
- package/docs/excel-formulas.md +2 -2
- package/docs/export.md +3 -3
- package/docs/fill.md +2 -3
- package/docs/formats.md +2 -6
- package/docs/groups-and-totals.md +3 -5
- package/docs/history.md +4 -5
- package/docs/pages-and-server-mode.md +3 -4
- package/docs/range-copy-and-paste.md +3 -4
- package/docs/reference-columns.md +117 -0
- package/docs/reference-table.md +2 -0
- package/docs/row-numbers-and-letters.md +3 -5
- package/docs/rows.md +3 -5
- package/docs/selection-and-keyboard.md +1 -5
- package/docs/sheet-formulas.md +4 -6
- package/docs/sheet-options.md +2 -6
- package/docs/sort-filter-and-search.md +3 -4
- package/package.json +2 -2
- package/src/index.ts +12 -0
package/docs/cell-editing.md
CHANGED
|
@@ -228,9 +228,8 @@ Press Edit, then press a day: its editor opens. Type Sunday and press Tab: the d
|
|
|
228
228
|
|
|
229
229
|
## Names
|
|
230
230
|
|
|
231
|
-
- **
|
|
232
|
-
|
|
233
|
-
-
|
|
234
|
-
- **Exports:** `applyEdits`, `cellValue`, `emptyValue`, `useEditDraft`, and the types `EditDraft`, `EditDraftOptions`, `CellEdit`, `TableEditDetails`, `TableEditReason`, `StandardSchemaV1`, `EditorSlotProps`.
|
|
231
|
+
- **Exports:** `applyEdits`, `cellValue`, `emptyValue`, `useEditDraft`, and the types `TableEditDetails`, `TableEditReason`, `StandardSchemaV1`.
|
|
232
|
+
|
|
233
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
235
234
|
|
|
236
235
|
See the [Edit tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=edit).
|
package/docs/cells-and-slots.md
CHANGED
|
@@ -118,7 +118,8 @@ A scoped style of your component does not reach the elements that the table rend
|
|
|
118
118
|
|
|
119
119
|
## Names
|
|
120
120
|
|
|
121
|
-
- **
|
|
122
|
-
|
|
121
|
+
- **Attribute types:** `RowAttrsContext`, `CellAttrsContext`, `PartAttrs`.
|
|
122
|
+
|
|
123
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
123
124
|
|
|
124
125
|
See the [More tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=more).
|
|
@@ -92,6 +92,8 @@ Without Vue, `controller.subscribe(listener)` runs the listener after each chang
|
|
|
92
92
|
## Names
|
|
93
93
|
|
|
94
94
|
- **Vue:** `createTableController`, `useTableView`, `useTableSearch`, `useSelectionSummary`.
|
|
95
|
-
- **Types:** `
|
|
95
|
+
- **Types:** `PageUnit`.
|
|
96
|
+
|
|
97
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
96
98
|
|
|
97
99
|
See the [More tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=more).
|
package/docs/excel-formulas.md
CHANGED
|
@@ -108,7 +108,7 @@ See the [Formula tiles of the sink](https://falldownthesystem.github.io/ui-sdk-t
|
|
|
108
108
|
|
|
109
109
|
## Names
|
|
110
110
|
|
|
111
|
-
- **Options of `toXlsx` and `downloadXlsx`:** `formula`, with `excelFormulas()` of the formulas entry.
|
|
112
111
|
- **Exports of the formulas entry:** `excelFormulas`, `EXCEL_FUNCTIONS`.
|
|
113
112
|
- **Exports of the export entry:** the type `XlsxFormulas`.
|
|
114
|
-
|
|
113
|
+
|
|
114
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
package/docs/export.md
CHANGED
|
@@ -85,8 +85,8 @@ With `manualPage`, the table has one page of a server, so each set of rows is of
|
|
|
85
85
|
|
|
86
86
|
## Names
|
|
87
87
|
|
|
88
|
-
- **
|
|
89
|
-
|
|
90
|
-
|
|
88
|
+
- **Export entry:** `toCsv`, `toXlsx`, `downloadCsv`, `downloadXlsx`, `downloadFile`, `zip`, `XLSX_TYPE`, and the type `XlsxFormulas`.
|
|
89
|
+
|
|
90
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
91
91
|
|
|
92
92
|
See the [More tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=more).
|
package/docs/fill.md
CHANGED
|
@@ -103,8 +103,7 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
103
103
|
|
|
104
104
|
## Names
|
|
105
105
|
|
|
106
|
-
- **Options:** `fillHandle` (`true`, `'vertical'`, `'horizontal'`, `false`).
|
|
107
|
-
- **Controller:** `fillCells`.
|
|
108
106
|
- **Attributes:** `data-filling` on the table; `data-fill-target` and `data-fill-edge` on a cell; the part `table-fill-handle`.
|
|
109
|
-
- **Messages:** `cellsFilled`, `fillRefused`, `fillNowhere`, `fillOverPinned`.
|
|
110
107
|
- **Exports:** `fillValues`, `fillLine`, `TableFillHandle`, and the types `FillWay`, `FillDirection`, `FillDraft`.
|
|
108
|
+
|
|
109
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
package/docs/formats.md
CHANGED
|
@@ -145,11 +145,7 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
145
145
|
|
|
146
146
|
## Names
|
|
147
147
|
|
|
148
|
-
- **Options:** `cellFormats`, `defaultCellFormats`, `formatColors`.
|
|
149
|
-
- **Events:** `cell-formats-change`, `update:cell-formats`.
|
|
150
|
-
- **Controller:** `formatCells`, `clearCellFormats`, `toggleCellFormat`, `getCellFormat`.
|
|
151
|
-
- **View:** `cellFormats`.
|
|
152
|
-
- **Slot props:** `format` in `#cell` and `#col-{id}`.
|
|
153
148
|
- **Attributes:** `data-align`, `data-bold`, `data-italic`, `data-color`, `data-fill`, `data-format`.
|
|
154
|
-
- **Messages:** `cellsFormatted`.
|
|
155
149
|
- **Exports:** `setFormats`, `revertFormats`, `pruneFormats`, `resolveFormat`, `CELL_FORMAT_NAMES`, `CELL_ALIGNS`, `CELL_DATE_STYLES`, and the types `CellFormat`, `CellFormats`, `CellFormatPatch`, `CellFormatName`, `FormatPlace`, `FormatTarget`.
|
|
150
|
+
|
|
151
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
@@ -95,10 +95,8 @@ A group row holds no values. Its cells are never part of a cell range, and a cop
|
|
|
95
95
|
|
|
96
96
|
## Names
|
|
97
97
|
|
|
98
|
-
- **
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
- **Slots:** `#group`, `#group-total`, `#group-total-{column id}`, `#foot`, `#foot-{column id}`.
|
|
102
|
-
- **Types:** `GroupRow`, `GroupPathEntry`, `AggregateName`, `AggregateFn`, `ColumnTotal`, `TableTotalsSource`.
|
|
98
|
+
- **Types:** `AggregateName`, `AggregateFn`, `TableTotalsSource`.
|
|
99
|
+
|
|
100
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
103
101
|
|
|
104
102
|
See the [Group tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=group).
|
package/docs/history.md
CHANGED
|
@@ -114,8 +114,7 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
114
114
|
|
|
115
115
|
## Names
|
|
116
116
|
|
|
117
|
-
-
|
|
118
|
-
- **
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
- **Types:** `HistoryEntry`, `TableStepReason`.
|
|
117
|
+
- `undo` and `redo` throw with the reason: no history, nothing to undo, a refused report, a check that runs.
|
|
118
|
+
- **Types:** `TableStepReason`.
|
|
119
|
+
|
|
120
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
@@ -195,9 +195,8 @@ A manual stage keeps the state: the sort, the filter and the page are requests t
|
|
|
195
195
|
|
|
196
196
|
## Names
|
|
197
197
|
|
|
198
|
-
- **
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
- **Types:** `PageState`, `PageUnit`, `ColumnFacetsSource`, `TableTotalsSource`.
|
|
198
|
+
- **Types:** `PageUnit`, `ColumnFacetsSource`, `TableTotalsSource`.
|
|
199
|
+
|
|
200
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
202
201
|
|
|
203
202
|
See the [Rows tiles](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=rows) and the [Server tiles](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=server) of the sink.
|
|
@@ -95,7 +95,6 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
95
95
|
|
|
96
96
|
## Names
|
|
97
97
|
|
|
98
|
-
- **
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
- **Exports:** `useSelectionSummary`, `summarize`, and the types `RangeSummary`, `SelectionSummaryOptions`.
|
|
98
|
+
- **Exports:** `useSelectionSummary`, `summarize`, and the type `SelectionSummaryOptions`.
|
|
99
|
+
|
|
100
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
@@ -36,6 +36,123 @@ See [Columns](./column-definitions.md) for how they work together.
|
|
|
36
36
|
- `exportValue?` (`(row: Row) => unknown`): The value of a cell in an export, in place of the cell value and its format: for a column whose cell is a slot, or whose file value differs from the screen.
|
|
37
37
|
- `meta?` (`unknown`): Data of the app for the column. The table does not read it.
|
|
38
38
|
|
|
39
|
+
## FormatOptions
|
|
40
|
+
|
|
41
|
+
`formatOptions` of a column takes the options of its `format`. Every format takes the options of `CommonFormatOptions`; the formats below take their own too.
|
|
42
|
+
|
|
43
|
+
### CommonFormatOptions
|
|
44
|
+
|
|
45
|
+
- `nullValue?` (`string`): The text for `null`. Defaults to an empty text.
|
|
46
|
+
- `undefinedValue?` (`string`): The text for `undefined`. Defaults to an empty text.
|
|
47
|
+
- `emptyValue?` (`string`): The text for an empty text. Defaults to an empty text.
|
|
48
|
+
- `invalidValue?` (`string`): The text for a value that the format cannot read. Defaults to an empty text.
|
|
49
|
+
- `prefix?` (`string`): Text before the formatted value.
|
|
50
|
+
- `suffix?` (`string`): Text after the formatted value.
|
|
51
|
+
- `locale?` (`string`): Overrides `FormatContext.locale` for this column.
|
|
52
|
+
|
|
53
|
+
### NumberFormatOptions
|
|
54
|
+
|
|
55
|
+
For `integer`, `decimal` and `number`, and with the options of `currency` and `percentage`.
|
|
56
|
+
|
|
57
|
+
- `roundingMode?` (`RoundingMode`): How a number rounds: `round` (half away from zero), `ceil`, `floor` or `trunc`.
|
|
58
|
+
- `multiplier?` (`number`): A factor that the value is multiplied by before it is shown. 0 changes nothing.
|
|
59
|
+
- `style?` (`'decimal' | 'percent' | 'currency' | 'unit'`): The `style` of `Intl.NumberFormat` for `integer`, `decimal` and `number`. Defaults to `decimal`.
|
|
60
|
+
- `notation?` (`'standard' | 'scientific' | 'engineering' | 'compact'`): The `notation` of `Intl.NumberFormat`, such as `compact` for 1.2K.
|
|
61
|
+
- `compactDisplay?` (`'short' | 'long'`): With `notation: 'compact'`: `short` (1.2K) or `long` (1.2 thousand).
|
|
62
|
+
- `useGrouping?` (`boolean`): Whether thousands are grouped, as in 1,000. Defaults to true.
|
|
63
|
+
- `minimumIntegerDigits?` (`number`): The fewest digits before the decimal sign, filled with zeros.
|
|
64
|
+
- `minimumFractionDigits?` (`number`): The fewest decimals. Defaults to 2 for `decimal`, `number` and `currency`, and 0 for `percentage`. `integer` shows none.
|
|
65
|
+
- `maximumFractionDigits?` (`number`): The most decimals. Defaults to 2 for `decimal`, `number` and `currency`, and 0 for `percentage`, or the minimum when it is larger.
|
|
66
|
+
- `minimumSignificantDigits?` (`number`): The fewest significant digits, as in `Intl.NumberFormat`.
|
|
67
|
+
- `maximumSignificantDigits?` (`number`): The most significant digits, as in `Intl.NumberFormat`.
|
|
68
|
+
|
|
69
|
+
### CurrencyFormatOptions
|
|
70
|
+
|
|
71
|
+
For `currency`, with every option of `NumberFormatOptions`.
|
|
72
|
+
|
|
73
|
+
- `currency?` (`string`): The currency as an ISO 4217 code, such as `USD`. Defaults to `EUR` with `showUnit`.
|
|
74
|
+
- `currencyDisplay?` (`'symbol' | 'code' | 'name' | 'narrowSymbol'`): How the currency shows with `showUnit`: `symbol` (the default), `code`, `name` or `narrowSymbol`.
|
|
75
|
+
- `currencySign?` (`'standard' | 'accounting'`): `accounting` writes a negative amount in parentheses where the locale does so.
|
|
76
|
+
- `showUnit?` (`boolean`): Without it the value is formatted as a plain decimal.
|
|
77
|
+
|
|
78
|
+
### PercentageFormatOptions
|
|
79
|
+
|
|
80
|
+
For `percentage`, with every option of `NumberFormatOptions`.
|
|
81
|
+
|
|
82
|
+
- `scale?` (`'fraction' | 'percent'`): `'fraction'` (default) reads 0.25 as 25 %; `'percent'` reads 25 as 25 %.
|
|
83
|
+
- `showUnit?` (`boolean`): Without it the value is formatted without the % sign.
|
|
84
|
+
|
|
85
|
+
### DateFormatOptions
|
|
86
|
+
|
|
87
|
+
For `date`, `time` and `datetime`.
|
|
88
|
+
|
|
89
|
+
- `dateStyle?` (`'full' | 'long' | 'medium' | 'short'`): The length of the date, as in `Intl.DateTimeFormat`. Defaults to `medium` when no field of the date is set.
|
|
90
|
+
- `timeStyle?` (`'full' | 'long' | 'medium' | 'short'`): The length of the time, as in `Intl.DateTimeFormat`. Defaults to `short` when no field of the time is set.
|
|
91
|
+
- `weekday?` (`'long' | 'short' | 'narrow'`): The weekday, as in `Intl.DateTimeFormat`. A field wins over `dateStyle`.
|
|
92
|
+
- `year?` (`'numeric' | '2-digit'`): The year, as in `Intl.DateTimeFormat`. A field wins over `dateStyle`.
|
|
93
|
+
- `month?` (`'numeric' | '2-digit' | 'long' | 'short' | 'narrow'`): The month, as in `Intl.DateTimeFormat`. A field wins over `dateStyle`.
|
|
94
|
+
- `day?` (`'numeric' | '2-digit'`): The day, as in `Intl.DateTimeFormat`. A field wins over `dateStyle`.
|
|
95
|
+
- `hour?` (`'numeric' | '2-digit'`): The hour, as in `Intl.DateTimeFormat`. A field wins over `timeStyle`.
|
|
96
|
+
- `minute?` (`'numeric' | '2-digit'`): The minute, as in `Intl.DateTimeFormat`. A field wins over `timeStyle`.
|
|
97
|
+
- `second?` (`'numeric' | '2-digit'`): The second, as in `Intl.DateTimeFormat`. A field wins over `timeStyle`.
|
|
98
|
+
- `hour12?` (`boolean`): Whether the clock has 12 hours. Without it, the locale decides.
|
|
99
|
+
- `timeZone?` (`string`): The zone of the clock that a moment shows in, such as `Europe/Paris`. A `YYYY-MM-DD` value is a day and shows that day in every zone. Without it, local time.
|
|
100
|
+
- `timeZoneName?` (`'long' | 'short'`): Writes the name of the zone after the time.
|
|
101
|
+
|
|
102
|
+
### RelativeTimeFormatOptions
|
|
103
|
+
|
|
104
|
+
For `relativeTime`.
|
|
105
|
+
|
|
106
|
+
- `localeMatcher?` (`'best fit' | 'lookup'`): As in `Intl.RelativeTimeFormat`. Defaults to `best fit`.
|
|
107
|
+
- `numeric?` (`'always' | 'auto'`): `auto` writes "yesterday" for -1 day; `always` (the default) writes "1 day ago".
|
|
108
|
+
- `style?` (`'long' | 'short' | 'narrow'`): The length of the words: `long` (the default), `short` or `narrow`.
|
|
109
|
+
- `unit?` (`RelativeTimeUnit`): The unit of the difference. Defaults to `day`.
|
|
110
|
+
- `calculateDifference?` (`boolean`): When false the value is already a difference in `unit`, not a point in time.
|
|
111
|
+
- `capitalize?` (`boolean`): Writes the first letter as a capital.
|
|
112
|
+
- `now?` (`number | Date`): The moment differences are measured from. Defaults to the current time.
|
|
113
|
+
|
|
114
|
+
### PeriodFormatOptions
|
|
115
|
+
|
|
116
|
+
For `period`.
|
|
117
|
+
|
|
118
|
+
- `unit?` (`PeriodUnit`): Which period the value is: the first day of a day, week, month, quarter or year, the moment of an hour, or a number of a day of the week. Defaults to `day`.
|
|
119
|
+
- `weekdays?` (`number`): With `unit: 'weekday'`: the type of `WEEKDAY` that gave the number, 1 (Sunday is 1, the default), 2 (Monday is 1), 3 (Monday is 0) or 11 to 17.
|
|
120
|
+
- `timeZone?` (`string`): With `unit: 'hour'`: the zone of the clock that the hour is shown in.
|
|
121
|
+
|
|
122
|
+
### UrlFormatOptions
|
|
123
|
+
|
|
124
|
+
For `url`.
|
|
125
|
+
|
|
126
|
+
- `url?` (`string`): One address for every cell, in place of the value.
|
|
127
|
+
- `text?` (`string`): One text for every cell, in place of the value.
|
|
128
|
+
- `openInNewTab?` (`boolean`): Whether the link opens in a new tab. Defaults to false.
|
|
129
|
+
- `download?` (`boolean | string`): `true` adds a bare `download` attribute; a string names the file.
|
|
130
|
+
- `urlSelector?` (`(row: unknown) => string`): The address of the cell, from its row.
|
|
131
|
+
- `textSelector?` (`(row: unknown) => string`): The text of the cell, from its row.
|
|
132
|
+
- `attributes?` (`Record<string, string>`): More attributes of the link. A name that is no valid attribute name is left out.
|
|
133
|
+
|
|
134
|
+
### EmailFormatOptions
|
|
135
|
+
|
|
136
|
+
For `email`.
|
|
137
|
+
|
|
138
|
+
- `asLink?` (`boolean`): Whether `linkOf` gives a `mailto:` link for the cell.
|
|
139
|
+
- `maskDomain?` (`boolean`): Shows the address without its domain, as `ada@...`.
|
|
140
|
+
- `textSelector?` (`(row: unknown) => string`): The text of the cell, from its row.
|
|
141
|
+
|
|
142
|
+
### BooleanFormatOptions
|
|
143
|
+
|
|
144
|
+
For `boolean`.
|
|
145
|
+
|
|
146
|
+
- `trueValue?` (`string`): The text for a true value. Defaults to `Yes`.
|
|
147
|
+
- `falseValue?` (`string`): The text for a false value. Defaults to `No`.
|
|
148
|
+
|
|
149
|
+
### TruncateFormatOptions
|
|
150
|
+
|
|
151
|
+
For `truncate`.
|
|
152
|
+
|
|
153
|
+
- `truncate?` (`number`): Maximum number of characters kept; unset or 0 keeps the whole text.
|
|
154
|
+
- `truncateSuffix?` (`string`): The text after a cut text. Defaults to `...`.
|
|
155
|
+
|
|
39
156
|
## SortRule
|
|
40
157
|
|
|
41
158
|
- `id` (`string`): The id of the column.
|
package/docs/reference-table.md
CHANGED
|
@@ -84,6 +84,8 @@ Props are written in camel case here; a template takes them in kebab case (`defa
|
|
|
84
84
|
- `cellAttrs?` (`(context: CellAttrsContext<Row>) => PartAttrs | undefined`): Attributes of a `th` or `td` element.
|
|
85
85
|
- `sectionAttrs?` (`{ head?: PartAttrs; body?: PartAttrs; foot?: PartAttrs }`): Attributes of the `thead`, `tbody` and `tfoot` elements.
|
|
86
86
|
|
|
87
|
+
`rowAttrs` and `cellAttrs` get a context with the `kind` of the row or the cell. [Attributes of rows and cells](./cells-and-slots.md#attributes-of-rows-and-cells) lists each kind with its fields.
|
|
88
|
+
|
|
87
89
|
## Events
|
|
88
90
|
|
|
89
91
|
- `update:sort` (`(value: readonly SortRule[]) => void`): The new `sort`, for `v-model:sort`. It does not run when `sortChange` cancels the change.
|
|
@@ -102,9 +102,7 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
102
102
|
|
|
103
103
|
## Names
|
|
104
104
|
|
|
105
|
-
- **Options:** `columnLetters`; column key `rowHeader`.
|
|
106
|
-
- **Controller:** `selectCellRows`, `selectCellColumns`.
|
|
107
|
-
- **Slots:** `#row-header`, `#letter`.
|
|
108
105
|
- **Attributes:** `data-row-header`, `data-corner`, `data-kind="letters"` on a row and `data-kind="letter"` on a cell.
|
|
109
|
-
- **
|
|
110
|
-
|
|
106
|
+
- **Exports:** `rowNumberColumn`, `columnLetter`, `lettersByColumn`.
|
|
107
|
+
|
|
108
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
package/docs/rows.md
CHANGED
|
@@ -291,10 +291,8 @@ Scroll the frame, or press Row 5,000. The table renders a few dozen rows at a ti
|
|
|
291
291
|
|
|
292
292
|
## Names
|
|
293
293
|
|
|
294
|
-
- **
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
- **Slots:** `#detail`.
|
|
298
|
-
- **Types:** `DataRow`, `TableRow`, `RowPin`, `RowPinning`, `DetailSlotProps`.
|
|
294
|
+
- **Types:** `TableRow`, `RowPin`.
|
|
295
|
+
|
|
296
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
299
297
|
|
|
300
298
|
See the [Rows tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=rows).
|
|
@@ -111,10 +111,6 @@ With `cellSelection`, a person selects a range of cells: Shift with an arrow, or
|
|
|
111
111
|
|
|
112
112
|
The cells of a range have `data-selected` and `data-range-edge`. The state is `cellRange`. [Range, copy and paste](./range-copy-and-paste.md) covers the rest.
|
|
113
113
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
- **Options:** `selection`, `canSelect`, `selected`, `defaultSelected`, `cellSelection`.
|
|
117
|
-
- **Events:** `selected-change`.
|
|
118
|
-
- **Controller:** `select`, `toggleSelected`, `selectRows`, `deselectRows`, `selectAll`, `clearSelection`, `selectCells`, `clearCellSelection`, `copyCells`.
|
|
114
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
119
115
|
|
|
120
116
|
See the [Rows tiles of the sink](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=rows).
|
package/docs/sheet-formulas.md
CHANGED
|
@@ -270,14 +270,10 @@ See the [Formula tiles of the sink](https://falldownthesystem.github.io/ui-sdk-t
|
|
|
270
270
|
|
|
271
271
|
## Names
|
|
272
272
|
|
|
273
|
-
- **Options:** `formulas` (the engine), `cell-formulas` and `default-cell-formulas` (`v-model:cell-formulas`), column key `allowFormula`. `createFormulaEngine({ timeZone?, maxReads? })`: `maxReads` (5,000,000 by default) refuses one change that would read more cells, such as a running sum by ranges over 50,000 rows.
|
|
274
273
|
- **Value:** `CellFormulas` is `{ columns?: { [columnId]: formula }, cells?: { [rowId]: { [columnId]: formula } } }`, in the stored form: plain data that an app saves with its document. `setFormulas`, `revertFormulas`, `pruneFormulas` and `formulaAt` of the formulas entry are the pure functions behind it.
|
|
275
|
-
- **
|
|
276
|
-
-
|
|
277
|
-
- **View:** `formulas` (the option is on), `cellFormulas`, `formula` (`FormulaView` of the active cell: `rowId`, `columnId`, `address`, `formula`, `text`, `value`, `error`, `ofColumn`).
|
|
278
|
-
- **Slot props:** `formula` in `#cell` and `#col-{id}` (`{ text, error?: { code, message } }`), in `#editor` and `#edit-{id}` (the formula as a person reads it; a save of a text with `=` sets a formula), and in `#header` (the formula of a computed column).
|
|
274
|
+
- **Controller:** the formula methods throw "This table has no formulas: pass `formulas`." without an engine. `getFormulaSummary(limit?)` gives each text of a column once with its count, so an agent reads 50,000 cells as one line.
|
|
275
|
+
- **`FormulaView`**, the `formula` of the view for the active cell: `rowId`, `columnId`, `address`, `formula`, `text`, `value`, `error`, `ofColumn`.
|
|
279
276
|
- **Attributes:** `data-formulas` on the table; `data-formula` on a cell with a formula of its own; `data-formula-error` (`div0`, `value`, `ref`, `name`, `num`, `na`, `cycle`) with the words of the error as `aria-description`; `data-formula-column` on the header and the cells of a computed column.
|
|
280
|
-
- **Messages:** `formulaIssue(issue)`, `formulaError(code)`, `recalculated({ cells })`. Without them, the English words of the engine (`describeFormulaIssue`).
|
|
281
277
|
- **Words of a refusal.** `editCell`, `setCellFormula` and `setColumnFormula` throw an `Error` whose `message` is for a developer or an agent: it names the column, the row and the text (`Column "total" refuses "=SUMM(B2)" for row "l2": No function …`). Its `cause` is a text with the words for a person, the words that the editor of the cell shows. A control beside the table shows the `cause`; `useFormulaBar().error` does that already.
|
|
282
278
|
|
|
283
279
|
```ts
|
|
@@ -297,3 +293,5 @@ See the [Formula tiles of the sink](https://falldownthesystem.github.io/ui-sdk-t
|
|
|
297
293
|
}
|
|
298
294
|
```
|
|
299
295
|
- **Exports of the formulas entry:** `createFormulaEngine`, `formulaColumn`, `compileRowFormula`, `parseFormula`, `printFormula`, `formulaShows`, `formulaSigns`, `describeFormulaIssue`, `FORMULA_FUNCTIONS`, `setFormulas`, `revertFormulas`, `pruneFormulas`, `formulaAt`, `excelFormulas`, `EXCEL_FUNCTIONS`, `useFormulaBar`. Of the export entry: the `formula` option of `toXlsx` and the type `XlsxFormulas`.
|
|
296
|
+
|
|
297
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
package/docs/sheet-options.md
CHANGED
|
@@ -172,11 +172,7 @@ See the [Sheet tiles of the sink](https://falldownthesystem.github.io/ui-sdk-tab
|
|
|
172
172
|
|
|
173
173
|
## Names
|
|
174
174
|
|
|
175
|
-
- **Options:** `sheet`, `editable`, `cellSelection`, `history`, `fillHandle`, `columnAggregates`, `defaultColumnAggregates`; column key `numberKeyboard`.
|
|
176
|
-
- **Events:** `column-aggregates-change`, `update:column-aggregates`.
|
|
177
|
-
- **Controller:** `clearCells`, `cutCells` (returns the text), `selectAllCells`, `selectCellRows(from, to?)`, `selectCellColumns(from, to?)`, `setColumnAggregate`.
|
|
178
|
-
- **View:** `canUndo`, `canRedo`, `activeCell`, `cellSelection`, `columnAggregates`.
|
|
179
|
-
- **Slot props:** `selectColumn` in `#header`; `mode`, `typed` and `inputMode` in `#editor` and `#edit-{id}`; `aggregate` and `setAggregate` in `#foot`, `aggregate` in `#group-total`.
|
|
180
175
|
- **Attributes:** `data-sheet`, `data-aggregate`.
|
|
181
|
-
- **Messages:** `cellsCleared`, `cellsCut`, `clearRefused`, `clearNowhere`, `aggregateLabel`, `totalLabel`.
|
|
182
176
|
- **Exports:** `emptyValue`, `aggregateName`, and the types `ColumnAggregates`, `AggregateName`, `TableStepReason`.
|
|
177
|
+
|
|
178
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
@@ -232,10 +232,9 @@ Press Northway. The colors list counts only the shoes of Northway. Press Black t
|
|
|
232
232
|
|
|
233
233
|
## Names
|
|
234
234
|
|
|
235
|
-
- **
|
|
236
|
-
- **Events:** `sort-change`, `filter-change`.
|
|
237
|
-
- **Controller:** `sortBy`, `toggleSort`, `setSearch`, `inputSearch`, `flushSearch`, `setColumnFilter`, `clearFilters`, `clearColumnFilters`, `getFacets`.
|
|
238
|
-
- **Exports:** `useTableSearch`, `createDebounce`, `sliderBounds`, `isEmptyFilter`, and the types `SortRule`, `FilterState`, `FilterKind`, `FilterMatcher`, `MultiSortMode`, `ColumnFacets`, `ColumnFacetValue`, `FacetOptions`, `TableSearch`.
|
|
235
|
+
- **Exports:** `useTableSearch`, `createDebounce`, `sliderBounds`, `isEmptyFilter`, and the types `FilterKind`, `FilterMatcher`, `MultiSortMode`.
|
|
239
236
|
- **Attributes:** `aria-sort`, `data-sorted` and `data-sort-index` on a header cell.
|
|
240
237
|
|
|
238
|
+
Every option, event, slot, controller method and view field of this page is in the reference: [Table](./reference-table.md), [Controller](./reference-controller.md) and [View](./reference-view.md).
|
|
239
|
+
|
|
241
240
|
See the [Sort tiles](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=sort) and the [Filter tiles](https://falldownthesystem.github.io/ui-sdk-table/?page=sink&only=filter) of the sink.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ui-sdk-table-vue",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Vue parts for the ui-sdk-table primitive: slots, v-model and controllers.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"data-grid",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"access": "public"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"ui-sdk-table-core": "0.2.
|
|
40
|
+
"ui-sdk-table-core": "0.2.2"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@types/jsdom": "^30.0.0",
|
package/src/index.ts
CHANGED
|
@@ -91,6 +91,18 @@ export type {
|
|
|
91
91
|
TableTotalsSource,
|
|
92
92
|
FilterKind,
|
|
93
93
|
FormatName,
|
|
94
|
+
FormatOptions,
|
|
95
|
+
CommonFormatOptions,
|
|
96
|
+
NumberFormatOptions,
|
|
97
|
+
CurrencyFormatOptions,
|
|
98
|
+
PercentageFormatOptions,
|
|
99
|
+
DateFormatOptions,
|
|
100
|
+
RelativeTimeFormatOptions,
|
|
101
|
+
UrlFormatOptions,
|
|
102
|
+
EmailFormatOptions,
|
|
103
|
+
BooleanFormatOptions,
|
|
104
|
+
TruncateFormatOptions,
|
|
105
|
+
PeriodFormatOptions,
|
|
94
106
|
ExportData,
|
|
95
107
|
ExportOptions,
|
|
96
108
|
ColumnPin,
|