Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions _data/components/currencyInput.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ attributes: [{
default : "right",
required : "",
description : "Position of the currency symbol"
},{
name : "currency-symbol-column",
type: "string",
default: "",
since: "15.9.0",
description: "Column name containing the currency symbol for each row. Default:$. Supports nested properties using dot notation (e.g., 'currency.symbol')"

}]

inheritedOutputs: [{
Expand Down
110 changes: 110 additions & 0 deletions _data/components/data-view.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
directive: "o-data-view"
version: "15.0.0"

apiTitle: "ODataViewComponent"
inheritedAttributes:
[
{
component: "OServiceBaseComponent",
path: "components/service/service-base/api",
attributes:
[
"attr",
"columns",
"configure-service-args",
"delete-method",
"entity",
"insert-method",
"keys",
"pageable",
"paginated-query-method",
"parent-keys",
"query-fallback-function",
"query-method",
"query-on-bind",
"query-on-init",
"query-rows",
"query-with-null-parent-keys",
"service",
"service-type",
"static-data",
"store-state",
"update-method",
"show-buttons-text",
"quick-filter-placeholder",
"insert-button",
"refresh-button",
"fixed-header",
"controls",
"title",
"quick-filter",
"quick-filter-appearance",
"recursive-detail",
"recursive-edit",
"recursive-insert",
"detail-form-route",
"pagination-controls",
"insert-form-route",
"filter-case-sensitive",
],
},
]

attributes:
[
{
name: "default-view",
type: "'table' | 'grid'",
default: "table",
required: "",
description: "Default view rendered by the component.",
},
{
name: "toggle-button",
type: "no | false | yes | true",
default: "yes",
required: "",
description: "Indicates whether or not to show the built-in view toggle. By default it is enabled, which is the standard way `o-data-view` provides view switching.",
},
{
name: "toggle-on-toolbar",
type: "no | false | yes | true",
default: "no",
required: "",
description: "Indicates whether or not to render the view toggle inside the toolbar.",
},
{
name: "toggle-floatable",
type: "no | false | yes | true",
default: "no",
required: "",
description: "Indicates whether or not the view toggle is rendered as a floating control.",
},
{
name: "table-config",
type: "TableConfig",
default: "",
required: "",
description: "Table view configuration object. Values defined here have precedence over the global table configuration injection token and the component defaults.",
},
{
name: "grid-config",
type: "GridConfig",
default: "",
required: "",
description: "Grid view configuration object.",
},
{
name: "delete-button",
type: "no | false | yes | true",
default: "yes",
required: "",
description: "Indicates whether or not to show a button for deleting data",
},
{ name: "insert-button" },
{ name: "refresh-button" },
]

extraComponents: "dataViewData"

directives: [{ name: "oDataViewTableColumns" }, { name: "oDataViewGridItem" }]
59 changes: 59 additions & 0 deletions _data/components/dataViewData/01.tableConfig.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
directive: "table-config"
title: "Table configuration"

inheritedAttributes:
[
{
component: "OTableComponent",
path: "components/data/table/api",
attributes:
[
"visible",
"detailButtonInRow",
"detailButtonInRowIcon",
"editButtonInRow",
"editButtonInRowIcon",
"editFormRoute",
"rowHeight",
"autoAdjust",
"autoAlignTitles",
"collapseGroupedColumns",
"columnsVisibilityButton",
"defaultVisibleColumns",
"deleteButton",
"disableSelectionFunction",
"detailMode",
"editionMode",
"enabled",
"exportButton",
"exportServiceType",
"filterColumnActiveByDefault",
"groupable",
"groupedColumns",
"horizontalScroll",
"keepSelectedItems",
"multipleSort",
"nonHidableColumns",
"pageSizeOptions",
"orderable",
"quickFilterFunction",
"resizable",
"rowClass",
"selectAllCheckbox",
"selectAllCheckboxVisible",
"selectionMode",
"showConfigurationOption",
"showExpandableIconFunction",
"showFilterOption",
"showPaginatorFirstLastButtons",
"showReportOnDemandOption",
"showChartsOnDemandOption",
"showResetWidthOption",
"sortColumns",
"virtualScroll",
"visibleColumns",
"visibleExportDialogButtons",
"selectionOnRowClick",
],
},
]
28 changes: 28 additions & 0 deletions _data/components/dataViewData/02.gridConfig.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
directive: "grid-config"
title: "Grid configuration"

inheritedAttributes:
[
{
component: "OGridComponent",
path: "components/data/grid/api",
attributes:
[
"enabled",
"visible",
"cols",
"gridItemHeight",
"gutterSize",
"insertButtonFloatable",
"insertButtonPosition",
"pageSizeOptions",
"orderable",
"quickFilterColumns",
"showFooter",
"showPageSize",
"sortColumn",
"sortableColumns",
"detailMode",
],
},
]
52 changes: 52 additions & 0 deletions _data/components/dataViewData/types/grid-config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
type: "GridConfig"

description: "Represents the configuration object used by <code>o-data-view</code> to customize the embedded <a href='https://ontimizeweb.github.io/docs/v15/components/data/grid/api'>o-grid</a> view.
All options are equivalent to the <code>o-grid</code> inputs, so you can consult its API to understand the meaning of each property.
<div class='language-html highlighter-rouge'><div class='highlight'><pre class='highlight'><code>
type GridConfig = {
enabled?: CustomBoolean;
visible?: CustomBoolean;
cols?: number;
gridItemHeight?: string | number;
gutterSize?: string;
insertButtonFloatable?: CustomBoolean;
insertButtonPosition?: 'botton' | 'top';
pageSizeOptions?: any[];
orderable?: CustomBoolean;
quickFilterColumns?: string;
showFooter?: CustomBoolean;
showPageSize?: CustomBoolean;
sortColumn?: string;
sortableColumns?: string;
detailMode?: 'none' | 'click' | 'dblclick';
};
</code></pre></div></div>
"

propertiesColumns: ["Name", "Type", "Description"]

attributes:
[
{ name: "enabled", type: "'yes' | 'no' | 'true' | 'false'", optional: true },
{ name: "visible", type: "'yes' | 'no' | 'true' | 'false'", optional: true },

{ name: "cols", type: "number", optional: true },
{ name: "gridItemHeight", type: "string | number", optional: true },
{ name: "gutterSize", type: "string", optional: true },

{ name: "insertButtonFloatable", type: "'yes' | 'no' | 'true' | 'false'", optional: true },
{ name: "insertButtonPosition", type: "'botton' | 'top'", optional: true },

{ name: "pageSizeOptions", type: "any[]", optional: true },
{ name: "orderable", type: "'yes' | 'no' | 'true' | 'false'", optional: true },

{ name: "quickFilterColumns", type: "string", optional: true },

{ name: "showFooter", type: "'yes' | 'no' | 'true' | 'false'", optional: true },
{ name: "showPageSize", type: "'yes' | 'no' | 'true' | 'false'", optional: true },

{ name: "sortColumn", type: "string", optional: true },
{ name: "sortableColumns", type: "string", optional: true },

{ name: "detailMode", type: "'none' | 'click' | 'dblclick'", optional: true }
]
Loading
Loading