@ahoo-wang/wow-view-engine/ui symbol index
Every name @ahoo-wang/wow-view-engine/ui exports — 250 — with its kind and the first sentence of its TSDoc, generated from the built declarations. 21 of them are described by hand in the curated pages, linked in the last column; the rest are read from their source through the signature in the API report. This index is English only.
| Symbol | Kind | Summary | Covered in |
|---|---|---|---|
AUDIENCE_ICON | const | Who a view is for: one person or several. | — |
AlertTone | type | How loud a callout is; it decides the colour, the icon and the role. | — |
AnalysisChart | function | Draws what the kernel already shaped. | — |
AnalysisChartProps | interface | — | — |
AnalysisHost | type | What the analysis parts read of the workbench around them: the data workbench's own controller, or — for an analysis made inside a dashboard (D22 C) — the few members a dialog holding its own view supplies. | — |
AnalysisParts | function | What makes an analysis view an analysis view: the conditions, what to aggregate, and the result as a table or a chart. | — |
AnalysisPartsProps | interface | — | — |
AnalysisTable | function | The aggregation as a table: groups first, then metrics, with the totals row from its own ungrouped query rather than from summing what is on screen. | — |
AnalysisTableProps | interface | — | — |
AppliedBar | function | The conditions the rows below were fetched under. | — |
AppliedBarProps | interface | — | — |
BUILT_IN_PRESETS | const | The presets @ahoo-wang/wow-view-engine/themes.css ships, by name, in the order it lists them (themes.md 4.1, D35) — for a host that builds its own picker, and for the completion of a preset prop. | — |
BoardFilterModes | interface | The modes a page gives a board's filters, and its time grouping. | — |
BuiltInPreset | type | The name of a preset the package ships. | — |
CellField | type | What a renderer knows about the field a value came from — which is what any reading of a value needs, cellText in a CSV included, so it is that type under the name this side uses for it. | — |
CellSurface | type | Where the reading is drawn, which is the one thing the two surfaces disagree about: how many lines a value may take. | — |
ChartImageSlot | interface | Where a chart hands over its capture; null takes it back. | — |
ChartMapGeoJson | interface | A GeoJSON feature collection, as far as a map chart reads one: each feature's properties.name is the region's name, which the region dimension's values — as their column shows them — are matched against. | — |
ChartMapSource | interface | A map a host offers the map chart (D41). | — |
ColorMode | type | The modes a reader may pick: the system's, or one pinned. | — |
ColorModeControl | interface | What useColorMode hands a host's switch. | — |
ColumnSettings | function | Which columns the table shows, in which order, pinned where, summarised how. | — |
ColumnSettingsProps | interface | — | — |
ContentPanel | function | The static panels: a note, a picture, a list of links. | — |
ContentPanelProps | interface | — | — |
ControlAria | interface | What a form that is not a condition — a declared action's — says of a control besides its name: the id a visible label points at, the hint it is described by, and that it must be filled. | — |
ControlChromeProps | interface | What a control inside a pill takes on top of the vendored component's, written out rather than read off the class recipe so the public type does not follow it (R2-85); test/variants.test.tsx holds the two in step. | — |
DashboardEditExtensions | interface | The parts of building a board that live outside the edit bar and the panel menu (D22 C–E): the big 「新建分析」 dialog, the presentation editor, promoting an owned analysis to a saved view, copying a personal view for a shared board, and the tab bar. | — |
DashboardEditExtensionsContext | const | — | — |
DashboardExtensionsOptions | interface | — | — |
DashboardFilterMode | type | How an embedding page offers each of a board's filters (D22, the embedding half): Metabase's three states, one per filter. | — |
DashboardGrid | function | The panels, placed. | — |
DashboardGridProps | interface | — | — |
DashboardPanel | function | One framed panel: a title, its menu, the two arrange controls while the board is built, a body. | — |
DashboardPanelProps | interface | — | — |
DashboardTabs | function | A board's tabs (D22 E): a bar over the grid — under the edit bar while the board is built — drawn only when there are two or more; one tab reads as none. | — |
DashboardTabsProps | interface | — | — |
DashboardWorkbench | function | The default Dashboard workbench: the view list, the board's filters, the panels and the save commands. | Workbenches and Embeds |
DashboardWorkbenchProps | interface | — | Workbenches and Embeds |
DataViewKind | type | The kinds of view a data definition holds; a dashboard is a definition of its own. | — |
DataWorkbench | function | The data workbench: one view list of record and analysis views, and the editor and result of whichever is open. | Workbenches and Embeds |
DataWorkbenchProps | interface | — | Workbenches and Embeds |
DetachedDialog | interface | A window opened from a toolbar, whose content is drawn outside it: the export's (ExportButton, ExportMenu). | — |
DetachedPopover | interface | A popover opened from a toolbar, whose content is drawn outside it. | — |
DialogHandle | type | The handle DetachedDialog joins its two halves by. | — |
DisplayContext | interface | Where a value is shown: the language, and the zone its times read in. | — |
DisplayField | interface | What a column knows about the field behind it. | — |
EditingCommands | interface | 「编辑面板」: what a panel offers while the board is being built. | — |
EditorBand | function | The fold the editor of a view lives in. | — |
EditorBandProps | interface | — | — |
EditorBandToggle | function | The handle of the editor's fold, in the title bar. | — |
EditorBandToggleProps | interface | — | — |
EditorFold | function | The one fold the handle and the band are two halves of. | — |
EditorFoldProps | interface | — | — |
ElementField | interface | One field of an element, by its name within the element. | — |
ElementTitleField | interface | The element field an array of objects is read by, one element each. | — |
EmbedBaseProps | interface | What both embeds take, the view or the board they show aside. | Workbenches and Embeds |
EmbedInteraction | type | How far a reader may go with an embed (D22, D36). | Workbenches and Embeds |
EmbedSize | type | How tall an embed is. | — |
EmbeddedDashboard | function | One saved dashboard inside a business page (D22): the board, its filter bar with each filter in the mode the page gives it, and what the host switched on — a tier (interaction), the title, the panel titles, a panel's export, auto-refresh, filling the screen, 在工作台中打开. | Workbenches and Embeds |
EmbeddedDashboardProps | interface | — | Workbenches and Embeds |
EmbeddedView | function | One saved record or analysis view inside a business page: the result, and what the host switched on around it (D22). | Workbenches and Embeds |
EmbeddedViewProps | interface | — | Workbenches and Embeds |
EmptyWayOut | type | The one way out of a query that matched nothing, by what was asked. | — |
ErrorStrip | function | What stops the view from running. | — |
ErrorStripProps | interface | — | — |
ExportButton | function | The export's own button and its window: one bordered icon button at the end of the toolbar's right-hand block (D12 Ⅳ), because exporting is a display facility like the columns and the sort — it changes nothing about the view and nothing about the records. | — |
ExportDialog | function | Taking the result away: what is picked, or everything the applied conditions match — chosen, waited for and read in one window (D14). | — |
ExportDialogProps | interface | — | — |
ExportOffer | interface | What a surface hands over to offer an export of its result — the run itself, plus the two things only the surface can say about the file. | — |
ExportWindowProps | interface | — | — |
ExportedFile | interface | One file an export produced, as it was handed over. | — |
FilterPanel | function | The condition builder. | — |
FilterPanelProps | interface | — | — |
FilterValueEditor | function | One value control, chosen by the descriptor the field kind produced. | — |
FilterValueEditorProps | interface | — | — |
FinalFocus | type | Where a dialog the board opened hands the keyboard back as it closes. | — |
FveToken | type | Every host variable of the contract: --fve-<token>, and--fve-dark-<token> for a token with a dark half. | — |
HandleMove | type | One move a handle asks its list for: a place either way (an arrow key, or 「往前移一位」／「往后移一位」 in its menu), or either end of the list. | — |
HeaderSorting | interface | What the analysis table's headers read and write the sort through. | — |
HeadingLevel | type | — | — |
HeadingPanel | function | A section's title across the board: one line of plain text, cut short rather than wrapped, since a heading card is one row high. | — |
HeadingPanelProps | interface | — | — |
HostColorMode | type | Who paints the mode: the engine, starting from one of the three, or the host. | — |
ImagePanel | function | — | — |
ImagePanelProps | interface | — | — |
IssueStripProps | interface | — | — |
KIND_ICON | const | The face each kind and each audience wears. | — |
LeaveDialog | function | The confirmation that stands between an open view and the next one. | — |
LeaveDialogProps | interface | — | — |
LineAlert | function | One callout, one line high. | — |
LineAlertFrame | type | How a LineAlert is framed; see LineAlertProps.frame. | — |
LineAlertProps | interface | What a LineAlert takes: a div's props, its tone and its frame. | — |
LinksPanel | function | A list of links, one Item per line (decisions.md D16-3). | — |
LinksPanelProps | interface | — | — |
MarkdownPanel | function | Markdown with raw HTML left off, which is the whole point of using it. | — |
MarkdownPanelProps | interface | — | — |
MessageFormatters | interface | What a component needs: a label by key, an issue or a list as a sentence. | — |
MessageKey | type | Every key this package ships, as a union. | — |
MessageOverrides | type | A host's rewording of the engine's own keys, checked against them: write an override as { … } satisfies MessageOverrides, and a key the engine renames or drops is a compile error rather than wording that silently falls back to the engine's sentence. | Host Wiring |
MessagesProvider | function | The wording every default component reads. | Host Wiring |
MessagesProviderProps | interface | — | Host Wiring |
NewAnalysis | interface | What 「放进仪表盘」 hands the board: the analysis it owns, and its title. | — |
NewAnalysisDialog | function | A new analysis made inside the dashboard (D22 C): a large dialog that is the analysis view itself — first the data it is about, then the same tray and the same result as the workbench's (AnalysisParts), running as it is edited under the reader's own 「改了就跑」 — and a title that follows what it shows until its author names it. | — |
NewAnalysisDialogProps | interface | — | — |
NewPanelSpot | interface | Where a panel added from the edit bar goes: its tab, from the first row on screen. | — |
NewViewCommand | interface | The one command behind every "new view" control: which kinds a view may be made of here, and the making. | — |
NewViewControl | function | A control that makes a view, in whichever form its place needs. | — |
NewViewItem | function | The same command inside a menu that is already open — the switcher's: one kind is one item, several are a submenu of the kinds. | — |
NoteStrip | function | What is true about the answer and not wrong with it, as a quiet line: the groups a view's own limit left out, when every row shown is whole (note, IssueSeverity). | — |
NumberInput | function | A number field, on Base UI's NumberField. | — |
OnPick | type | Told which group of the result a mark stands for when it is pressed, and where — the mark's element, or the point pressed — so the follow-up menu opens against it. | — |
PanelCommands | type | What one panel's menu offers, each present only when it can be done (D4): 「数据」 always (ViewingCommands), 「编辑面板」 while the board is being built (EditingCommands). | — |
PanelGridItem | function | One grid item, and the panel it holds said to what the grid appends to it. | — |
PanelGridItemProps | interface | — | — |
PanelHandle | function | The panel's one handle: a pointer drags it, and a keyboard arranges with it (V-02). | — |
PanelHandleProps | interface | — | — |
PanelHeadingLevel | type | Where a panel title may sit in a page's outline — never above a page title. | — |
PanelOrder | function | The handle a panel is carried along the one-column reading by (D22 J), where the grip and the corner are not: the handle every ordered list here is (DragHandle, 「可排序的列表一律拖拽排序」) — dragged by a pointer onto another panel's place, moved a place by ↑／↓, picked up by Space, or clicked for the menu of the four places it can go. | — |
PanelOrderProps | interface | — | — |
PanelPress | interface | What a press on one group of a panel can do, as the grid hands it to the panel (D22 H, I): its click, the host's route, and the board's commands on this panel's groups. | — |
PanelResizeHandle | function | The corner the pointer drags to resize, named and focusable. | — |
PanelResizeHandleProps | interface | — | — |
PickAnchor | type | Where a menu is placed: the mark or row pressed, or the point it was pressed at. | — |
PopoverHandle | type | The handle DetachedPopover joins its two halves by. | — |
PresentationDialog | function | 「改这里的展示」 (D22 D): the visualization panel of the analysis view — the same chart types, the same options, the same totals row — for one panel of a board, beside the panel as it will look. | — |
PresentationDialogProps | interface | — | — |
QueryStrip | function | A query that did not come back. | — |
QueryStripProps | interface | — | — |
RecordCards | function | The same result as cards, drawn from the card half of the saved config. | — |
RecordCardsProps | interface | — | — |
RecordCell | interface | — | — |
RecordDetailOptions | interface | What a host says about the record detail (G2): who holds which record is open (RecordDetailControl, as instanceId and onInstanceChange hold the open view), and what the host adds to it. | — |
RecordPagination | function | How many rows there are and how to reach the next of them. | — |
RecordPaginationProps | interface | — | — |
RecordPanelHost | interface | What a host puts on a board's record panels (D39): its declared actions on the records — a row's and a selection's, as a record workbench places them — and its slots after them, and what reading the board again means after a command. | — |
RecordParts | function | What makes a record view a record view: the condition band it edits in, and the toolbar, rows and paging it reads. | — |
RecordPartsProps | interface | — | — |
RecordTable | function | The record view as a table. | — |
RecordTableProps | interface | — | — |
RecordViewProps | interface | What a host may say about the record views a workbench draws: what may be done to a record, how a cell is read, whether rows can be picked, and what an empty result says. | Workbenches and Embeds |
RefreshControl | function | Refreshing the view: one press for now, the ▾ for how often by itself. | — |
RefreshControlProps | interface | — | — |
ReleasedPins | interface | Which pins the cap has taken back. | — |
RenderBoundary | function | A boundary around one part of a view. | — |
RenderBoundaryName | type | The parts of a view a render can fail in, each behind a boundary of its own, so that one of them failing leaves the others standing. | — |
RenderBoundaryProps | interface | — | — |
RenderFailure | interface | What a boundary caught, handed to the host as it is caught. | — |
RenderFailureHandler | type | — | — |
RenderParts | type | A kind's parts are made by a component, not a function: each kind's controller is a hook (useRecordTable, useAnalysisEditor), and a hook cannot be called on a branch. | — |
RenderSlot | function | A render function turned into an element, so that it runs inside the boundary around it rather than in whoever built the tree. | — |
ResultToolbar | function | The bar above the result: what is selected on the left, how the result is shown on the right. | — |
ResultToolbarProps | interface | — | — |
RevertDialog | function | The question in front of ↺. | — |
RevertDialogProps | interface | — | — |
RoutedTarget | type | A way off a board or a view that leads to one of the host's resources. | — |
RowActions | function | The wrapper a host's per-row actions land in. | — |
RowActionsProps | interface | — | — |
SYSTEM_ICON | const | A view that came with the definition: it travels with the code, so it is never renamed or deleted here, and a lock is that fact as a picture. | — |
SaveActions | function | Saving the open view: one button for the thing to do now, and a menu for the rest. | — |
SaveActionsProps | interface | Two of the group, and only two: this button group saves and copies, so those are the two landings it can report. | — |
SaveAsCommands | interface | What the form needs of the save commands: which audiences a create may go to, whether a write is out and what the last one said, and the create itself. | — |
SaveAsDialog | function | Making a copy of the open view: a title and who it is for. | — |
SaveAsDialogProps | interface | — | — |
Say | type | A definition's words as they are shown; see useSay. | — |
SelectionContext | type | What the selection's bar hands its actions: the selection itself. | — |
SharedSaveConfirm | function | 「这会更新所有人看到的「X」」: the one question before a shared view is written over. | — |
SortOwner | interface | What the editor needs of whoever owns the sort: the record table, or the analysis editor with its aliases standing in for fields. | — |
SortSettings | function | What the rows are ordered by, said on the button and edited behind it. | — |
SortSettingsProps | interface | — | — |
StatusStrip | function | Anything the view has to say that is not a row: a warning, a query that failed, a config that needs fixing before it runs. | — |
StatusStripProps | interface | — | — |
SurfaceKind | const | The one kind of view a surface has open, where it has one: a dashboard workbench or an embedded board says dashboard, a workbench of several kinds says nothing. | — |
TONE_ICON | const | The icon each tone wears, written once. | — |
TokenName | type | A registered token's name. | — |
UnsavedMark | function | The "edited" mark, with the way back on it. | — |
ViewBinding | interface | One definition's binding, as ViewHost takes it. | Host Wiring |
ViewBindingOptions | interface | — | Host Wiring |
ViewDensity | type | How dense a surface sits (themes.md 2.4, D35 Q63): the record and analysis tables' rows and cell padding, the view list's rows and the dashboard panels' padding — never a control's height, a type size or the dashboard's row. | — |
ViewDestination | type | What the host's navigate is handed: a route, where the target's definition has one; otherwise the target as it came — a URL, or a definition the host bound no route for. | — |
ViewExpandExit | function | The way back out of a surface whose control is not inside it. | — |
ViewExpandToggle | function | The control that fills the screen with this view, in the title bar's right-hand group: it is one of the answers to how am I looking at this, beside the editor's fold and before whatever the host adds. | — |
ViewExpandToggleProps | interface | — | — |
ViewExpansion | interface | Whether a surface fills the screen, and the one way to change it. | — |
ViewHeader | function | The one line that says which view this is, and the one place it is saved from. | — |
ViewHeaderProps | interface | The bar passes the write callbacks through rather than declaring its own: they are ViewWriteCallbacks, and the components underneath here — the button group and the outcome line — are what call them. | — |
ViewHeaderState | type | What a title bar reads off the open view. | — |
ViewHost | function | The host's one entry (host-integration.md 4.2): a few ports the host fills — data (engine), router, theme, language, commands (bindings) — around every surface under it, each taking only what differs where it stands: <DataWorkbench definitionId={ORDERS} />. | Host Wiring |
ViewHostProps | interface | — | Host Wiring |
ViewList | function | The views of one definition, grouped by who they are for, in the user's own order within each group. | — |
ViewListProps | interface | — | — |
ViewLocation | interface | Where the host's router is (host-integration.md 4.2): what the engine reads the open view (?view=), the open record (?id=) and what a page was handed (ViewRouteState, the history entry's state) from. | — |
ViewManager | function | Managing the views rather than looking at one: rename, delete, reorder and choose which one opens first. | — |
ViewManagerProps | interface | — | — |
ViewMessages | type | Wording, by key. | Host Wiring |
ViewNavigationItem | interface | One resource the host routes to, as a place of its navigation. | — |
ViewNavigationView | interface | One system view (or system board) of a resource, as a link. | — |
ViewPreset | type | What a preset prop takes: a built-in preset, with completion, or the name of one the host wrote the same way (:where([data-fve-preset='acme'])).string & {} keeps the built-in names in completion while any string still type-checks; a bare string would swallow the union. | — |
ViewRoute | interface | A way off a board or a view, resolved through its definition's route: the host's path, and what the page there is handed. | — |
ViewRouteOf | type | Where a view or a board of a definition lives in the host's address.target is the way off it was asked for; it is absent where the engine asks for a link rather than a way off — a resource's or a system view's place in the host's navigation (useViewNavigation). | — |
ViewRouteState | interface | What the page a route opens is handed with it, as history state. | — |
ViewRouter | interface | The router port (host-integration.md 4.2): the host's router as the engine reads and moves it — the one bridge to it, whichever library it is. | Host Wiring |
ViewSurface | function | — | — |
ViewSurfaceProps | interface | — | — |
ViewSwitcher | function | The view list as one control, for when there is no room for the list. | — |
ViewSwitcherProps | interface | — | — |
ViewTheme | type | The mode a surface is asked for: light or dark pins it, system follows the reader's prefers-color-scheme, live. | — |
ViewWriteCallbacks | interface | What a host is told about the writes of one open view. | — |
ViewingCommands | interface | 「数据」: what a panel offers whoever reads the board. | — |
WarningStrip | function | The findings that do not block, said once and in one line. | — |
WorkbenchFeatures | interface | Which of the workbench's own controls a host wants on screen (D18 XI). | — |
WorkbenchLandmark | type | The landmark the work column is (Q64): main, the page's main content, or a named region for a host whose own <main> the workbench stands in — a page has one main, and one inside another is no longer top level. | — |
WorkbenchParts | type | What one kind of view puts into the shell's slots: its editor and how it folds, its toolbar, its result and the way out of an error, and the host's actions over it. | — |
WorkbenchShell | function | The frame the three default workbenches share: the view list beside it, the title bar over it, the findings under that, and the two slots that make one kind different from another. | — |
WorkbenchShellProps | interface | — | — |
WriteOutcome | function | What became of the last write of the open view, and the way out of it. | — |
WriteOutcomeProps | interface | — | — |
bind | function | Binds a definition's behaviour in the host (host-integration.md 4). | Host Wiring |
cellText | function | One cell as text, for somewhere a React node cannot go — a CSV file, a copied selection, a title attribute. | — |
cellValue | function | One value as its field reads it. | — |
dedupeIssues | function | One of each sentence. | — |
displayValue | function | A value as its field shows it, or undefined when the field's kind has nothing to add and the caller's own rendering stands: a number keeps its format, a boolean its wording. | — |
en | const | English wording for everything this package can report, by area. | — |
fileName | function | A file name from a view's title and a day: 订单待办-2026-09-20.csv. | — |
formatIssue | function | One issue as a sentence. | — |
formatIssues | function | Several issues, in order, joined for one alert. | — |
formatMessage | function | One entry with its params filled in. | — |
keptKey | function | What an editor gives back for a label it showed as say(original): the original — a key stays a key — where the reader left the words as they were shown, else what they typed. | — |
kindIssue | function | An issue about the thing open, said as its kind says it: 「仪表盘保存失败」 on a board where a view says 「视图保存失败」. | — |
kindWord | function | The key a kind says key with: its own where it has one. | — |
registerChartMap | function | Offers a map to every map chart on the page, by name; a second one of the same name takes its place. | — |
tableTime | function | A time as a table cell writes it: short, and numeric where the language writes it so — 09-17 21:19 in Chinese, Sep 17, 9:19 PM in English — with the year only when it is not the current one (2025-09-17 21:19,Sep 17, 2025, 9:19 PM), and the seconds only when the column asks for them (timePrecision: 'second'). | — |
useColorMode | function | The page's mode and a way to pick one, for the host's own switch (a menu in its top bar): what the ViewHost above paints. | — |
useDashboardEditExtensions | function | The extensions in force; none by default. | — |
useDashboardExtensions | function | The board's extensions (DashboardEditExtensions, D22 C–E) as the default workbench fills them: 「新建分析」 opens the dialog a board-owned analysis is made in, 「改这里的展示」 the visualization panel for one panel's look, 「恢复为视图的样子」 puts the view's own look back, 「另存为视图」 the save-as dialog that promotes an owned analysis, 「复制为共享视图并替换」 the same dialog copying a personal view for a shared board, and the tab bar. | — |
useEngine | function | The engine a surface draws: its own, else its provider's. | — |
useKindIssue | function | kindIssue for the kind the surface has open (SurfaceKind). | — |
useKindWord | function | kindWord for the kind the surface has open (SurfaceKind). | — |
useSaidText | function | A box that edits a label as it is typed: what it shows — value in words — and what a keystroke gives back (keptKey, against the value the box opened on), so words typed back to what was shown are the key again. | — |
useSay | function | How a definition's keys (text(key)) are said here: in the wording in force — the nearest provider's messages, merged over the ones above — else in the words the engine was built with, else as the key itself (D2). | — |
useSurfaceAttributes | function | The attributes a popup takes from the surface it opened from, so the stylesheet resolves it as it does the surface: the mode, the preset, the change convention, the density and whether the first chart slot follows the brand. | — |
useSurfaceDisplay | function | The language and zone the nearest surface shows values in. | — |
useSurfaceFont | function | — | — |
useSurfaceHostTokens | function | — | — |
useSurfaceTheme | function | — | — |
useSurfaceTokens | function | — | — |
useViewExpansion | function | Let a surface fill the screen where it stands. | — |
useViewMessages | function | The formatters for the wording in force here, with messages merged over it and its numbers grouped in locale. | — |
useViewNavigation | function | The places of the host's navigation (host-integration.md 4.3), from theViewHost above: every registered resource the host bound a route to, in the order they were registered, with its system views; titles said in the words in force, so a change of language redraws it, and a resource registered or bound differently changes it. | — |
zhCN | const | 简体中文文案，与 en 逐键对应。 | — |