@stonecrop/atable 0.6.2 → 0.7.0

package/README.md

@@ -67,9 +67,9 @@ const config = {
 
 The primary API for ATable is the column object.
 
-- `title`: String; optional
+- `label`: String; optional (the display label for the column header)
 - `name`: String; required (a reference to the column that must follow rules for valid JS variable naming)
-- `type`: String; optional (a valid data types, full list [below](#column-data-types))
+- `fieldtype`: String; optional (a valid field type, full list [below](#column-data-types))
 - `align`: String; optional (one of `left`, `right` or `center`; defaults to `center`)
 - `edit`: Boolean; optional (indicates if the field is editable; defaults to `false`)
 - `width`: String; optional (used to indicate the width of the cell; defaults to `40ch`)
@@ -78,16 +78,16 @@ The primary API for ATable is the column object.
 
 ```js
 {
-  title: 'Batch Name',
+  label: 'Batch Name',
   name: 'name',
-  type: 'Data',
+  fieldtype: 'Data',
   align: 'right',
   edit: false,
 },
 {
-  title: 'Species',
+  label: 'Species',
   name: 'species',
-  type: 'Select',
+  fieldtype: 'Select',
   align: 'left',
   edit: true,
   width: '30ch',
@@ -95,9 +95,9 @@ The primary API for ATable is the column object.
   options: () => ['Rainbow Trout', 'Steelhead', 'Golden Trout', 'Pacific Salmon']
 },
 {
-  title: 'Date',
+  label: 'Date',
   name: 'set_date',
-  type: 'Date',
+  fieldtype: 'Date',
   align: 'center',
   edit: true,
   width: '30ch',
@@ -124,8 +124,8 @@ import { ref } from 'vue'
 
 const tableData = ref([...])
 const tableColumns = ref([
-  { name: 'id', label: 'ID', width: '80px', type: 'Data' },
-  { name: 'name', label: 'Name', width: '150px', type: 'Data' },
+  { name: 'id', label: 'ID', width: '80px', fieldtype: 'Int' },
+  { name: 'name', label: 'Name', width: '150px', fieldtype: 'Data' },
 ])
 
 const onColumnsChange = (columns) => {

package/dist/atable.d.ts

@@ -180,7 +180,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -204,7 +204,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -474,7 +474,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -498,7 +498,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -768,7 +768,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -792,7 +792,7 @@ name: string;
 align?: CanvasTextAlign | undefined;
 edit?: boolean | undefined;
 label?: string | undefined;
-type?: string | undefined;
+fieldtype?: string | undefined;
 width?: string | undefined;
 pinned?: boolean | undefined;
 resizable?: boolean | undefined;
@@ -1240,15 +1240,12 @@ export declare interface TableColumn {
      */
     label?: string;
     /**
-     * The data-type of the column. Possible values:
-     * - `Data` - the column contains text data
-     * - `Select` - the column contains a select input
-     * - `Date` - the column contains a date input
-     * - `component` - the column contains a custom component
+     * The semantic field type of the column. Uses the same StonecropFieldType enum as forms.
+     * Common values: 'Data', 'Text', 'Int', 'Float', 'Date', 'Select', 'Link', 'Check', etc.
      *
-     * @beta
+     * @public
      */
-    type?: string;
+    fieldtype?: string;
     /**
      * The width of the column. This can be a number (in pixels) or a string (in CSS units).
      *