| \n\n$id\n\n | \n\nString or Number\n\n | \n\nRequired. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).Format: `Now.ID['String' or Number]`\n\n |
| \n\nname\n\n | \n\nString\n\n | \n\nRequired. A name for the widget.\n\n |
| \n\ncategory\n\n | \n\nString\n\n | \n\nThe type of widget.Valid values:\n\n- standard\n- otherApplications\n- custom\n- sample\n- knowledgeBase\n- servicePortal\n- serviceCatalog\n\nDefault: custom\n\n |
| \n\nclientScript\n\n | \n\nScript\n\n | \n\nA client-side script that defines the AngularJS controller. This property supports inline JavaScript or a reference to another file in the application that contains a script. Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide an inline script, use string literals or template literals for multiple lines of code: `'Script' or `Script``.\n\nDefault:\n\n```javascript\napi.controller=function() { /* widget controller */ var c = this;};\n```\n\n |
| \n\nserverScript\n\n | \n\nScript\n\n | \n\nA server-side script that sets the initial widget state, sends data to the widget's client script using the `data` object, or runs server-side queries. This property supports inline JavaScript or a reference to another file in the application that contains a script. Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide an inline script, use string literals or template literals for multiple lines of code: `'Script' or `Script``.\n\nDefault:\n\n```javascript\n(function () { /* populate the 'data' object */ /* e.g., data.table = $sp.getValue('table'); */ })();\n```\n\n |
| \n\ncontrollerAs\n\n | \n\nString\n\n | \n\nA variable for a reference to the controller in the directive's scope. The client script accesses the server data object using the `c.data` variable by default.Default: c\n\n |
| \n\nhtmlTemplate\n\n | \n\nString\n\n | \n\nThe body HTML code that defines what is rendered when the page is shown. It can contain either static XHTML, dynamically generated content defined as Jelly, or call script includes and UI Macros. This property supports a reference to another file in the application that contains HTML or inline HTML.Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide inline HTML, use string literals or template literals for multiple lines of code: `'HTML' or `HTML``.\n\nDefault:\n\n```xml\n\n```\n\n |
| \n\ncustomCss\n\n | \n\nString\n\n | \n\nThe CSS or SCSS that defines the widget style. This property supports a reference to another file in the application that contains CSS or inline CSS. Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide inline CSS, use string literals or template literals for multiple lines of code: `'CSS' or `CSS``.\n\n |
| \n\ndataTable\n\n | \n\nString\n\n | \n\nThe table in which to store widget instance options. To define a custom option schema, you can add fields to a table that extends the Widget Instance \\[sp\\_instance\\] table and set your widget to use the extension table as a data source. For more information, see [Store instance options in a table](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_WidgetInstanceOptions.md).Default: sp\\_instance\n\n |
| \n\ndemoData\n\n | \n\nString or Object\n\n | \n\nData that demonstrates the widget functionality. This property supports inline strings, a reference to another file in the application that contains JSON, or inline JSON serializable objects.Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide inline JSON, use an object with key and value pairs: `{ key: value }`.\n\n |
| \n\ndescription\n\n | \n\nString\n\n | \n\nA description of the widget and its purpose.\n\n |
| \n\ndocs\n\n | \n\nReference\n\n | \n\nThe variable identifier of the Service Portal documentation \\[sp\\_documentation\\] that provides additional information about the widget and its purpose. To define Service Portal documentation, see [Record API - ServiceNow Fluent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/record-api-now-ts.md).\n\n |
| \n\nfields\n\n | \n\nArray\n\n | \n\nA list of column names from the data table to use in the widget option schema.\n\n |
| \n\nhasPreview\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether you can preview the widget from the Widget Editor.Valid values:\n\n- true: You can preview the widget from the Widget Editor.\n- false: You can't preview the widget from the Widget Editor.\n\nDefault: false\n\n |
| \n\nid\n\n | \n\nString\n\n | \n\nA unique ID for the widget. The ID can't contain spaces.\n\n |
| \n\nlinkScript\n\n | \n\nScript\n\n | \n\nA link function that uses AngularJS to directly manipulate the DOM. This property supports inline JavaScript or a reference to another file in the application that contains a script.Format:\n\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide an inline script, use string literals or template literals for multiple lines of code: `'Script' or `Script``.\n\nDefault:\n\n```javascript\nfunction link(scope, element, attrs, controller) { }\n```\n\n |
| \n\nroles\n\n | \n\nArray\n\n | \n\nA list of variable identifiers of Role objects or names of roles that can access the widget. For more information, see [Role API - ServiceNow Fluent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/role-api-now-ts.md).\n\n |
| \n\noptionSchema\n\n | \n\nArray\n\n | \n\nA list of parameters that a Service Portal administrator \\(sp\\_admin\\) can configure for a widget instance. The widget option schema supports reusing a widget and uniquely configuring instances of the widget on different pages. For more information, see [Widget option schema](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_WidgetInstanceOptions.md).```javascript\noptionSchema: [\n {\n name: 'String',\n label: 'String',\n section: 'String',\n type: 'String',\n defaultValue: 'String',\n hint: 'String'\n },\n...\n]\n```\n\n- name: Required. The name of the parameter.\n- label: Required. A label for the parameter that appears in the widget instance options.\n- section: Required. The section of the widget instance options in which the parameter appears.\n\nValid values:\n\n - data\n - behavior\n - documentation\n - presentation\n - other\n- type: Required. The data type of the parameter.\n\nValid values:\n\n - string\n - boolean\n - integer\n - reference\n - choice\n - fieldList\n - fieldName\n - glideList\n - glyphIcon\n- defaultValue: The default value of the parameter.\n- hint: A short description of the parameter that displays as tooltip when hovering over it.\n\n |
| \n\npublic\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the widget is available to unauthenticated users.Valid values:\n\n- true: Unauthenticated users can access the widget.\n- false: Only authenticated users can access the widget.\n\nDefault: false\n\n |
| \n\ndependencies\n\n | \n\nArray\n\n | \n\nA list of variable identifiers of SPWidgetDependency objects or names or sys\\_ids of dependencies for the widget. For more information, see [SPWidgetDependency object](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-service-portal-api.md).\n\n |
| \n\nangularProviders\n\n | \n\nArray\n\n | \n\nA list of variable identifiers of SPAngularProvider objects or names or sys\\_ids of Angular providers for the widget. For more information, see [SPAngularProvider object](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-service-portal-api.md).\n\n |
| \n\ntemplates\n\n | \n\nArray\n\n | \n\nA list of Angular ng-templates \\[sp\\_ng\\_template\\] to associate with the widget. Angular ng-templates contain content that is rendered only when you instruct it to render.```javascript\ntemplates: [\n {\n $id: Now.ID['String' or Number]\n id: 'String'\n htmlTemplate: 'HTML' or `HTML` \n },\n ...\n]\n```\n\n- $id: Required. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id.\n\nFormat: `Now.ID['String' or Number]`\n\n- id: Required. The ID of the Angular ng-template.\n- htmlTemplate: Required. The HTML template content. This property supports a reference to another file in the application that contains HTML or inline HTML.\n\n |
| \n\n$meta\n\n | \n\nObject\n\n | \n\nMetadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.\n\n```javascript\n$meta: {\n installMethod: 'String'\n}\n```\n\nValid values for installMethod:\n\n- demo: Outputs the application metadata to the `metadata/unload.demo` directory to be installed with the application when the **Load demo data** option is selected.\n- first install: Outputs the application metadata to the `metadata/unload` directory to be installed only the first time an application is installed on an instance.\n\n |
\n