Skip to content

Hello World ​

The shortest path from a .as type to a working, server-driven table. You write the schema once; the server exposes it; the client mounts two components. No column definitions, no row mappers, no AJAX glue.

Prerequisites

This guide assumes you have a moost-db backend serving the /meta + CRUD HTTP surface for an .as table. If you don't, jump to Query Function for the custom queryFn escape hatch — it lets you skip moost-db entirely.

1. Define the schema ​

atscript
// src/schemas/Product.as
@db.table 'products'
export interface ProductsTable {
    @meta.id
    @db.default.increment
    id: number

    @meta.label 'Product Name'
    @db.index.fulltext 'products_search'
    name: string

    @meta.label 'Description'
    @db.index.fulltext 'products_search'
    description?: string

    @meta.label 'Price'
    price: number

    @meta.label 'In Stock'
    @db.default 'true'
    inStock: boolean

    @meta.label 'Category'
    @db.index.plain 'category_idx'
    category: 'electronics' | 'clothing' | 'food' | 'books' | 'toys' | 'other'

    @meta.label 'SKU'
    @db.index.unique 'sku_idx'
    sku: string

    @meta.label 'Created'
    @db.default.now
    createdAt: number
}

A handful of annotations carry a lot of weight here:

  • @meta.id — primary key. Surfaces in /meta.primaryKeys, drives row addressing for actions and __remove.
  • @meta.label — column header text. Falls back to a humanised path when omitted.
  • @db.index.fulltext — server-side $search index. Makes the table searchable (tableDef.searchable === true); the search box wires up automatically.
  • @db.index.plain / @db.index.unique — flag the column as filterable / sortable in /meta.fields[*], which in turn enables the column menu's filter and sort entries.
  • The 'electronics' | 'clothing' | … literal union becomes a preset list of options for the filter dialog without any extra wiring.

See Annotations Reference for the complete list.

2. Expose it ​

With moost-db wired up, the same .as file becomes a REST endpoint via @db.http.path (or via your moost-db routing). For the example below we assume /db/tables/products resolves to the standard AsDbReadableController (/meta, /q, CRUD, actions, value-help).

TIP

moost-db is documented in detail at db.atscript.dev — HTTP CRUD.

If you don't run moost-db, see Query Function — Path B.

3. Mount the table ​

vue
<script setup lang="ts">
import { AsTableRoot, AsTable, createDefaultCellTypes } from "@atscript/vue-table";
import TableToolbar from "../../components/TableToolbar.vue";
import TableFilterBar from "../../components/TableFilterBar.vue";
import TablePagination from "../../components/TablePagination.vue";

const types = createDefaultCellTypes();
</script>

<template>
  <div class="table-page">
    <AsTableRoot
      url="/db/tables/products"
      :types="types"
      :limit="10"
      v-slot="{ tableDef, loadedCount, totalCount, loadingMetadata }"
    >
      <TableToolbar
        title="Products"
        :table-def="tableDef"
        :loaded-count="loadedCount"
        :total-count="totalCount"
      />
      <div class="table-page-filters">
        <TableFilterBar />
      </div>
      <div class="table-page-body">
        <AsTable :column-menu="{ sort: true, filters: true, hide: true, resetWidth: true }" />
        <div v-if="loadingMetadata" class="table-loading-overlay" />
      </div>
      <TablePagination mode="pagination" />
    </AsTableRoot>
  </div>
</template>

That's the whole client.

Anatomy of the mount ​

<AsTableRoot> — the renderless orchestrator ​

AsTableRoot doesn't render any chrome of its own. It fetches /meta, builds the TableDef, owns reactive state and exposes everything via a slot. Key props:

PropPurpose
urlThe data endpoint. moost-db serves /meta and /q (paged data) under the same path.
limitDefault page size. Also the block size for <AsWindowTable> fetches.
typesCell-type → component dispatch map. Seed with createDefaultCellTypes(), override entries as you go.
componentsNamed component overrides looked up via @ui.table.component "name".
controlsSkin-slot overrides — header cell, column menu, filter dialog, config dialog, etc. Pass only the entries you replace; every slot falls back to its built-in internally.
queryFnReplace the built-in moost-db data fetcher with your own. See Query Function.
forceFiltersAlways-applied FilterExpr (Uniquery shape), AND-merged with user filters. Live since 0.1.148 — a change re-queries on page 1, no :key needed.
forceSortersAlways-applied SortControl[], prepended before user sorters; user can't remove them. Live since 0.1.148.
timeZoneIANA zone dates are read in (date filters, "today"). Default: the cell locale's, else the browser's. Since 0.1.148.
presetOpt-in preset configuration. Omit to disable presets.
queryOnMountDefault true. Set false if you want to defer the first fetch.

The default slot exposes the full reactive state — tableDef, allColumns, columns, columnNames, columnWidths, filterFields, filters, residualFilters, sorters, results, pagination, searchTerm, selectedRows, selectedCount, totalCount, loadedCount, plus the loading/error flags (querying, queryingNext, loadingMetadata, queryError, metadataError, mustRefresh), the keyboard nav bridge (navBridge), and the public methods (query, queryNext, resetFilters, showConfigDialog, openFilterDialog, closeFilterDialog, setFieldFilter, removeFieldFilter, setResidualFilters, removeResidualFilter, addFilterField, removeFilterField, actions, prompt). External v-models are supported for filterFields, columnNames, columnWidths, sorters, selectedRows and the URL bridge urlQuery.

Underneath, <AsTableRoot> also mounts its companion dialogs (AsFilterDialog, AsConfigDialog, AsConfirmDialog, and lazily AsActionFormDialog when actions carry @InputForm payloads) so column-menu and row-action flows work without any extra wiring on your side.

<AsTable> — the renderer ​

<AsTable> injects the root context and renders the actual <table>. It accepts presentational props only: :stickyHeader, :select (selection mode), :rowActionsColumn (insert a synthesised actions column), :columnMenu (which entries to show in the header dropdown), :reorderable, :resizable, :columnMinWidth. State props (:rows, :columns) are escape hatches — by default it reads state.results and state.columns straight from the context.

<AsWindowTable> is the virtualised twin. Same context, different renderer — see Pagination & Virtualization.

createDefaultCellTypes() and :controls ​

createDefaultCellTypes() returns a fresh cell-type map you can spread to extend or override. For :controls, pass only the entries you replace — every chrome slot falls back to its built-in internally, so spreading defaults is redundant (and opts the lazy dialogs into eager bundling):

ts
import { createDefaultCellTypes, AsTableCellValue } from "@atscript/vue-table";
import StatusBadgeCell from "./StatusBadgeCell.vue";
import MyFilterDialog from "./MyFilterDialog.vue";

const components = {
  status: StatusBadgeCell, // matches @ui.table.component 'status'
};

const controls = {
  filterDialog: MyFilterDialog, // only the overrides — no spreading defaults
};

The default cell-type map:

Cell typeDefault component
textAsTableCellValue
numberAsCellNumber
booleanAsTableCellValue
dateAsCellDate
datetimeAsCellDate
relativeAsCellDate
arrayAsCellArray
objectAsCellJson
unionAsCellUnion
enumAsTableCellValue
refAsTableCellValue
__actionsAsRowActions

Next steps ​

Released under the MIT License.