@nova-ui/bits/sdk/schematics/table/schema.json

SolarWinds Nova Framework

{
    "$id": "SchematicsNovaTableComponent",
    "$schema": "http://json-schema.org/schema",
    "description": "Adds a table",
    "properties": {
        "name": {
            "type": "string",
            "description": "The name of the component.",
            "$default": {
                "$source": "argv",
                "index": 0
            }
        },
        "path": {
            "type": "string",
            "format": "path",
            "description": "The path to create the service.",
            "visible": false
        },
        "project": {
            "type": "string",
            "description": "The name of the project.",
            "$default": {
                "$source": "projectName"
            }
        },
        "prefix": {
            "type": "string",
            "description": "The prefix to apply to the generated component selector.",
            "alias": "p",
            "oneOf": [
                {
                    "maxLength": 0
                },
                {
                    "minLength": 1,
                    "format": "html-selector"
                }
            ]
        },
        "flat": {
            "type": "boolean",
            "description": "When true, creates the new files at the top level of the current project.",
            "default": false
        },
        "skipImport": {
            "type": "boolean",
            "description": "When true, does not import this component into the owning NgModule.",
            "default": false
        },
        "selector": {
            "type": "string",
            "format": "html-selector",
            "description": "The HTML selector to use for this component."
        },
        "export": {
            "type": "boolean",
            "default": false,
            "description": "When true, the declaring NgModule exports this component."
        },
        "lintFix": {
            "type": "boolean",
            "default": false,
            "description": "When true, applies lint fixes after generating the component."
        },
        "module": {
            "type": "string",
            "description": "Allows specification of the declaring module.",
            "alias": "m"
        },
        "enableSearch": {
            "type": "boolean",
            "description": "When true, enables the search functionality for the list",
            "default": true
        },
        "enableSort": {
            "type": "boolean",
            "description": "When true, enables the search functionality for the list",
            "default": true
        },

        "dataSource": {
            "type": "string",
            "default": "serverSide",
            "x-prompt": {
                "message": "What is the source of your data?",
                "type": "list",
                "items": [
                    {
                        "value": "clientSide",
                        "label": "The generated data source will retrieve data locally from a client side source."
                    },
                    {
                        "value": "serverSide",
                        "label": "The generated data source will retrieve data remotely from a server side API."
                    },
                    {
                        "value": "custom",
                        "label": "No data source will be generated, allowing you to create one from scratch."
                    },
                    {
                        "value": "none",
                        "label": "No data source will be generated and no accommodations for a data source, e.g. sorting or search, will be added to the generated code."
                    }
                ]
            }
        },
        "dataSourceName": {
            "type": "string",
            "description": "Specifies the datasource class name"
        },
        "pagingMode": {
            "description": "Paging mode to be used for the table",
            "type": "string",
            "default": "virtualScroll",
            "enum": ["none", "pagination", "virtualScroll"],
            "x-prompt": {
                "message": "What paging mode would you like the list to use?",
                "type": "list",
                "items": [
                    { "value": "pagination", "label": "Pagination" },
                    { "value": "virtualScroll", "label": "Virtual Scroll" },
                    { "value": "none", "label": "None" }
                ]
            }
        },
        "selectionMode": {
            "description": "Selection mode to be used for the table",
            "type": "string",
            "default": "none",
            "enum": ["none", "multi"],
            "x-prompt": {
                "message": "What selection mode would you like the table to use?",
                "type": "list",
                "items": [
                    { "value": "none", "label": "None (Selection Disabled)" },
                    { "value": "multi", "label": "Multi-Select (Checkboxes)" }
                ]
            }
        },
        "virtualScrollStrategy": {
            "type": "string",
            "default": "standard",
            "description": "Strategy used for the virtual scroll",
            "enum": ["standard", "custom"]
        }
    },
    "required": ["name"],
    "title": "Generates table component",
    "type": "object"
}