diff --git a/docs/001_develop/02_server-capabilities/010_real-time-triggers-evaluator/index.mdx b/docs/001_develop/02_server-capabilities/010_real-time-triggers-evaluator/index.mdx index 592d74f84..5b904575d 100644 --- a/docs/001_develop/02_server-capabilities/010_real-time-triggers-evaluator/index.mdx +++ b/docs/001_develop/02_server-capabilities/010_real-time-triggers-evaluator/index.mdx @@ -29,7 +29,7 @@ When a trigger happens, an event handler event message is sent, and its business Unlike most server capabilities in the Genesis Application Platform, you don't have to configure a .kts file to set up Evaluator; it is entirely driven by records in these two tables: * `CRON_RULE` for time-based (scheduled) events; you specify the schedule as a [Quartz Cron Expression](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) -* `DYNAMIC_RULE` for data-update-driven events; you specify which value is to be monitored in a table or view, the boolean logic for triggering the vent, and the event tp be triggered +* `DYNAMIC_RULE` for data-update-driven events; you specify which value is to be monitored in a table or view, the boolean logic for triggering the event, and the event to be triggered ## Example configuration diff --git a/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/index.mdx b/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/index.mdx index 6ac563b33..1f3d87a86 100644 --- a/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/index.mdx +++ b/docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/index.mdx @@ -267,7 +267,7 @@ export class ConnectedGridServerSideExample extends GenesisElement {} ## Genesis Datasource -This folder contains implementations of Genesis `datasource` components, responsible for fetching data for Genesis [Grid Pro](../../README.md) components. +This folder contains implementations of Genesis `datasource` components, responsible for fetching data for Genesis Grid Pro component. This document outlines the available features of our two “Grid Pro” datasources: `` and ``. @@ -347,7 +347,7 @@ This document outlines the available features of our two “Grid Pro” datasour - Sorting uses `ORDERY_BY` param - Both work the same way, once filtering/sorting is applied the datasource component “resets itself”, basically starting a new stream with the updated params. - **LIMITATIONS** - - Sorting can only be applied to “index” fields/columns. Also mentioned [here](https://www.notion.so/Grid-Pro-Datasource-Inventory-d11ca7570ee94847bbcb3e7362025b0a?pvs=21). More details [here](https://genesisglobal.atlassian.net/jira/polaris/projects/GPR/ideas/view/4721227?selectedIssue=GPR-171&focusedCommentId=143757) and [here](https://genesis-global-talk.slack.com/archives/C0416MFG360/p1696456988606789). + - Sorting can only be applied to “index” fields/columns. - ROWS_COUNT doesn’t reflect the correct amount when a CRITERIA_MATCH (filtering) is applied. Example: X resource has 100 records. A criteria is specified so it returns only 50 records… the rows count sent from the server is still 100. Because of that we have to manually/locally calculate that. - Suitable for large datasets where only a subset of data is loaded into the client based on user interactions. diff --git a/docs/001_develop/03_client-capabilities/006_charts/01_chart-types.mdx b/docs/001_develop/03_client-capabilities/006_charts/01_chart-types.mdx index a2e3397e1..50f6033f2 100644 --- a/docs/001_develop/03_client-capabilities/006_charts/01_chart-types.mdx +++ b/docs/001_develop/03_client-capabilities/006_charts/01_chart-types.mdx @@ -927,10 +927,3 @@ const offSetValues = { After you have looked at the basics here, you can find more details in our [API Docs](./docs/api/index.md) ::: -## License - -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components - -Genesis Platform \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/006_charts/02_chart-datasource.mdx b/docs/001_develop/03_client-capabilities/006_charts/02_chart-datasource.mdx index 1c283896a..2bf81abc6 100644 --- a/docs/001_develop/03_client-capabilities/006_charts/02_chart-datasource.mdx +++ b/docs/001_develop/03_client-capabilities/006_charts/02_chart-datasource.mdx @@ -88,10 +88,3 @@ The chart groups (stacks) these categories for each year into a single bar, with After you have looked at the basics here, you can find more details in our [API Docs](./docs/api/index.md) ::: -## License - -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components - -Genesis Platform \ No newline at end of file diff --git a/docs/001_develop/03_client-capabilities/006_charts/index.mdx b/docs/001_develop/03_client-capabilities/006_charts/index.mdx index 270eb737a..7695dcd7a 100644 --- a/docs/001_develop/03_client-capabilities/006_charts/index.mdx +++ b/docs/001_develop/03_client-capabilities/006_charts/index.mdx @@ -192,10 +192,3 @@ export class AppComponent { :::info After you have looked at the basics here, you can find more details in our [API Docs](./docs/api/index.md) ::: - -## License - -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/01_json_schema.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/01_json_schema.mdx index ea8d9ec20..fff42441b 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/01_json_schema.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/01_json_schema.mdx @@ -267,9 +267,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [JSON/UI Schema example](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-json-schema). ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/02_ui_schema.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/02_ui_schema.mdx index 59b931dc6..fef5dad52 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/02_ui_schema.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/02_ui_schema.mdx @@ -664,9 +664,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [JSON/UI Schema example](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-json-schema) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/03_layouts.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/03_layouts.mdx index e1e82c9e8..da9dc8b20 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/03_layouts.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/03_layouts.mdx @@ -307,9 +307,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Layouts](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/form-layouts) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/04_input_controls.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/04_input_controls.mdx index 8b30bbb85..8a3ba5f29 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/04_input_controls.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/04_input_controls.mdx @@ -106,7 +106,7 @@ const booleanInputUiSchema: UiSchema = { ### Date control -The date control schema creates a date renderer with an input field and a date picker. To invoke this control, set the `description` property in the `JSONSchema` to `org.joda.time.DateTime`. The form only allows numbers to be input. it stores the date value in miliseconds in the underlying form model. +The date control schema creates a date renderer with an input field and a date picker. To invoke this control, set the `description` property in the `JSONSchema` to `org.joda.time.DateTime`. The form only allows numbers to be input. It stores the date value in milliseconds in the underlying form model. ```ts const dateInputJsonSchema: JSONSchema7 = { @@ -198,7 +198,7 @@ const textAreaInputUiSchema: UiSchema = { The select control schema creates a dropdown select box. Users can select only one value from the given list. -Tp invoke this renderer, include an `options` section in the `UISchemaElement` with an array of data. You can specify which properties of your array objects are used for the underlying option value, `valueField`, and for the display value, `labelField`. +To invoke this renderer, include an `options` section in the `UISchemaElement` with an array of data. You can specify which properties of your array objects are used for the underlying option value, `valueField`, and for the display value, `labelField`. ```ts // Select Input @@ -311,9 +311,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Controls](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/form-controls) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/05_rules.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/05_rules.mdx index 99fb58e8b..fe44fd78f 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/05_rules.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/05_rules.mdx @@ -137,9 +137,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Rules](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-with-rules) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/06_validation.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/06_validation.mdx index 948c6a783..d60c5815a 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/06_validation.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/06_validation.mdx @@ -184,9 +184,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Validation](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-validation) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/07_custom-controls.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/07_custom-controls.mdx index 07683951c..bfc93f85d 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/07_custom-controls.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/07_custom-controls.mdx @@ -143,9 +143,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Custom Controls](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-with-custom-renderers) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/08_html_api.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/08_html_api.mdx index 2f103ac07..d8b02014d 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/08_html_api.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/08_html_api.mdx @@ -63,9 +63,4 @@ Events can be received by the emitting ``, or any parent element. This component doesn't listen to any public API events. -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/09_filters.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/09_filters.mdx index 6545033ea..bee1bf46e 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/09_filters.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/09_filters.mdx @@ -386,9 +386,3 @@ It is crucial to manipulate the style of the foundation-filter in order to see t After you have looked at the basics here, you can find more details in our [API Docs](./docs/api/index.md) ::: -## License - -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/index.mdx b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/index.mdx index 5b7323f1a..0419ce1b0 100644 --- a/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/index.mdx +++ b/docs/001_develop/03_client-capabilities/007_forms/002_smart-forms/index.mdx @@ -711,9 +711,4 @@ After you have looked at the basics here, you can find more details in our [API Full source code at [Forms introduction](https://github.com/genesiscommunitysuccess/form-examples/tree/main/client/src/routes/forms-introduction) ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/008_interaction/modal.mdx b/docs/001_develop/03_client-capabilities/008_interaction/modal.mdx index c45606c31..3628be839 100644 --- a/docs/001_develop/03_client-capabilities/008_interaction/modal.mdx +++ b/docs/001_develop/03_client-capabilities/008_interaction/modal.mdx @@ -9,7 +9,7 @@ tags: - modal - click - toggle -sidebar_position: 10 +sidebar_position: 8 --- import ModalDemo from '../../../../examples/ui/client-capabilities/interaction/modal.js'; diff --git a/docs/001_develop/03_client-capabilities/008_interaction/tabs.mdx b/docs/001_develop/03_client-capabilities/008_interaction/tabs.mdx index f9c619cf3..59029be19 100644 --- a/docs/001_develop/03_client-capabilities/008_interaction/tabs.mdx +++ b/docs/001_develop/03_client-capabilities/008_interaction/tabs.mdx @@ -120,7 +120,7 @@ You will use `rapid-tabs`, `rapid-tab`, `rapid-tab-item` to create your tabs.
  • limoncello and Ice Cream with Biscotti
    • - + ) } ``` diff --git a/docs/001_develop/03_client-capabilities/008_interaction/tree-view.mdx b/docs/001_develop/03_client-capabilities/008_interaction/tree-view.mdx new file mode 100644 index 000000000..abc841135 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/008_interaction/tree-view.mdx @@ -0,0 +1,333 @@ +--- +title: 'Tree view' +sidebar_label: 'Tree view' +id: client-interaction-tree-view +keywords: [ interaction, interactive, menu, desktop, item, choice, nested, start menu, menu bar, action ] +tags: +- interaction +- interactive +- tree +- tree view +- directories +- directory +- heirarchy +- heirarchical +sidebar_position: 8 +--- + +import TreeViewDemo from '/examples/ui/client-capabilities/interaction/tree-view.js'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +A tree view widget presents a hierarchical list. Any item in the hierarchy may have child items, and items that have children may be expanded or collapsed to show or hide the children. + +Use cases: +* Creating a file system navigator that uses a tree view to display folders and files. An item representing a folder can be expanded to reveal the contents of the folder, which may be files, folders, or both. +* Creating a hierarchical diagram of profiles + +## Example + + + + + + + Declaration + ```html + + + + ``` + + Usage + ```typescript + @customElement({ + name: 'my-element', + template: html` + + Root + + Item 1 + Sub-item 1-1 + Sub-item 1-2 + + Item 2 + Sub-item 2-1 + Sub-item 2-2 + + + Item 3 + + `, + }) + export class MyElement extends GenesisElement { } + ``` + + + + + Declaration + ```html + + + + ``` + + Usage + ```typescript + export function MyComponent() { + return ( + + Root + + Item 1 + Sub-item 1-1 + Sub-item 1-2 + + Item 2 + Sub-item 2-1 + Sub-item 2-2 + + + Item 3 + ) + } + ``` + + + + Declaration + ```html + + + + ``` + + Usage + ```typescript + import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + @Component({ + selector: 'my-component', + template: ` + + Root + + Item 1 + Sub-item 1-1 + Sub-item 1-2 + + Item 2 + Sub-item 2-1 + Sub-item 2-2 + + + Item 3 + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], + }) + export class MyComponent { } + ``` + + + + +## Tree View API + +API examples shown with Genesis component syntax, and closing tag omitted. + +### Attributes + + + + + + + + + + + + + + + + + + +
    AttributeTypeDescriptionExample
    render-collapsed-nodesbooleanIf set true the tree view will appear expanded as if by being expanded by the user + +```typescript + x.showTree}> +``` + +
    + +### Properties + + + + + + + + + + + + + + + + + + +
    PropertyTypeDescriptionExample
    currentSelectedHTMLElement | TreeItem | nullThe currently selected tree item. It is likely you'll want to read this value instead of writing to it. + +```typescript +const value = treeRef.currentSelected; +``` + +
    + +### Slots + +|Slot|Description| +|---|---| +|Default|The default slot for content or ([``](#tree-item-api))| + +### Parts + +This component doesn't have any parts. + +### Events fired + +This component doesn't fire any events. + +### Events listened to + +This component doesn't listen to any events. + +## Tree item API + +API examples shown with Genesis component syntax, and closing tag omitted. + +### Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeTypeDescriptionExample
    expandedbooleanWhen true, the control will appear expanded by user interaction. Emits expanded-change event when changed. Note: is not set when the user interacts with the item, so only use this attribute to pre-expand the item open rather than read the state. + +```typescript + +``` + +
    selectedbooleanWhen true, the control will appear selected by user interaction. Emits selected-change event when changed. Note: is not set when the user interacts with the item, so only use this attribute to pre-select the item open rather than read the state. + +```typescript + +``` + +
    disabledbooleanWhen true, the control will be immutable by user interaction. + +```typescript + +``` + +
    + + +### Properties + +This component doesn't have any properties that are not also controlled via attributes. + +### Slots + +|Slot|Description| +|---|---| +|Default|The default slot for tree item text content| +|start|Content which can be provided before the tree item content| +|end|Content which can be provided after the tree item content| +|item|The slot for tree items (`` manage this assignment themselves)| +|expand-collapse-button|The expand/collapse button| + +### Parts + +|Part|Description| +|---|---| +|positioning-region|The element used to position the tree item content with exception of any child nodes| +|content-region|The element containing the expand/collapse, start, and end slots| +|items|The element wrapping any child items| +|expand-collapse-button|The expand/collapse button| + +### Events fired + + + + + + + + + + + + + + + + + + + + + + + + +
    EventTypeDescriptionExample
    expanded-changebooleanEmitted when the expanded attribute is changed + +```typescript + +``` + +
    selected-changebooleanEmitted when the selected attribute is changed + +```typescript + +``` + +
    + +### Events listened to + +This component doesn't listen to any events. + diff --git a/docs/001_develop/03_client-capabilities/009_presentation/examples/icon.js b/docs/001_develop/03_client-capabilities/009_presentation/examples/icon.js new file mode 100644 index 000000000..23691c9cb --- /dev/null +++ b/docs/001_develop/03_client-capabilities/009_presentation/examples/icon.js @@ -0,0 +1,31 @@ +import { CodeSection } from "../../../../../examples/ui/documentationBase.js"; +import useIsBrowser from "@docusaurus/useIsBrowser"; +import {useRef} from "react"; + +function setup() { + // Setup + const isBrowser = useIsBrowser(); + if (isBrowser) { + const RapidImports = require("../../../../../examples/ui/rapidImports"); + RapidImports.registerComponents(); + } +} + +export default function IconDemo({ children, color }) { + setup(); + return ( + +
    +
    +
    + +
    +
    + +
    + +
    +
    +     + ) +} diff --git a/docs/001_develop/03_client-capabilities/009_presentation/icon.mdx b/docs/001_develop/03_client-capabilities/009_presentation/icon.mdx new file mode 100644 index 000000000..cd0e384d5 --- /dev/null +++ b/docs/001_develop/03_client-capabilities/009_presentation/icon.mdx @@ -0,0 +1,201 @@ +--- +title: 'Icon' +sidebar_label: 'Icon' +id: client-presentation-icon +keywords: [presentation, icon, image] +tags: +- presentation +- icon +- image +sidebar_position: 9 +--- + +import IconDemo from './examples/icon.js'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Icon + +Use cases: +* Displaying a specified icon. +* An addition to presenting a listbox-option +* cell-renderers and many others + +:::note +You can use any free publicly-available icon from fontawesome. These are available via the links below: +- [solid/regular](https://fontawesome.com/search?o=r&m=free) icons +- [brand](https://fontawesome.com/search?o=r&m=free&f=brands) icons +Paying for fontawesome pro will enable the use of all icons via this component also. +::: + +## Example + + + + + + + + Declaration + ```html + + ``` + + Usage + ```typescript + @customElement({ + name: 'my-element', + template: html` + + + + `, + }) + export class MyElement extends GenesisElement { + } + ``` + + + + + Declaration + ```html + + ``` + Usage + ```typescript + export function MyComponent() { + return ( + + + + ); + } + ``` + + + + Declaration + ```html + + ``` + + Usage + ```typescript + import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; + @Component({ + selector: 'my-root', + template: ` + + + + `, + standalone: true, + schemas: [CUSTOM_ELEMENTS_SCHEMA], + }) + export class AppComponent { + } + ``` + + + +## API + +Property and attribute binding examples for Genesis Component syntax. Closing tag omitted. + +### Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionExample
    variant"solid" | "regular" | "brand"`solid` is the default, `regular` usually is slightly more finely drawn, `brand` is for brand icons only + +```typescript + +``` + +
    size"2xs" | "xs" | "sm" | "lg" | "xl" | "2xl" | "1x" | "2x" | "3x" | "4x" | "5x" | "6x" | "7x" | "8x" | "9x" | "10x"Controls the size of the icon. Default: "sm" + +```typescript + +``` + +
    namestringThe name of the icon (matching with the name in fontawesome). + +```typescript + +``` + +
    errorbooleanAdds error styling to the icon when tooltip attribute is also set. + +```typescript + +``` + +
    tooltipstringThe tooltip for the icon. If not set there is no tooltip. + +```typescript + +``` + +
    tooltip-idstringThe tooltip id. + +```typescript + +``` + +
    + +### Properties +This component doesn't have any properties which are not also controlled via attributes. + +### Slots +This component doesn't have any slots. + +### Parts +This component doesn't have any parts, + +### Events fired + +This component doesn't fire any events. + +### Events listened to + +This component doesn't listen to any events. diff --git a/docs/001_develop/03_client-capabilities/010_filters/index.mdx b/docs/001_develop/03_client-capabilities/010_filters/index.mdx index 2a79d17be..76b135339 100644 --- a/docs/001_develop/03_client-capabilities/010_filters/index.mdx +++ b/docs/001_develop/03_client-capabilities/010_filters/index.mdx @@ -437,9 +437,3 @@ console.log(outcome); // true if all the filters pass ``` -## License - -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis application platform diff --git a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-fdc3.mdx b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-fdc3.mdx index 1b1ea7714..74ecd9f56 100644 --- a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-fdc3.mdx +++ b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-fdc3.mdx @@ -99,9 +99,4 @@ export class MyComponent extends FASTElement { The FDC3 service is designed to be easily integrated and configured within your application using dependency injection. This approach allows for flexible instantiation and usage of the FDC3 API, ensuring that financial desktop applications can leverage standard communication protocols for enhanced interoperability. -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-openfin.mdx b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-openfin.mdx index 3c8128584..9c96374df 100644 --- a/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-openfin.mdx +++ b/docs/001_develop/03_client-capabilities/021_desktop-interoperability/01_foundation-openfin.mdx @@ -83,9 +83,4 @@ This package depends on a newer version of typescript which you will also need t > ``` -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis low-code platform diff --git a/docs/001_develop/04_business-components/03_reporting/foundation-reporting.mdx b/docs/001_develop/04_business-components/03_reporting/foundation-reporting.mdx index 5bcfd4806..b95df084e 100644 --- a/docs/001_develop/04_business-components/03_reporting/foundation-reporting.mdx +++ b/docs/001_develop/04_business-components/03_reporting/foundation-reporting.mdx @@ -91,10 +91,5 @@ public async configure() { If there are no reports in the database, you will see an error on the web page saying there are no reports to load - this is expected behaviour. ::: -## License -Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details. - -### Licensed components -Genesis application platform diff --git a/docs/04_web/12_forms/05_forms-controls.mdx b/docs/04_web/12_forms/05_forms-controls.mdx index 9e5c6dfae..99adbd73a 100644 --- a/docs/04_web/12_forms/05_forms-controls.mdx +++ b/docs/04_web/12_forms/05_forms-controls.mdx @@ -77,7 +77,7 @@ const booleanInputUiSchema: UiSchemaElement = { ![Date Input](/img/smart-forms/date-input.png) -The date control schema creates a date renderer with an input field and a date picker. To invoke this control, set the `description` property in the `JSONSchema` to `org.joda.time.DateTime`. The form only allows numbers to be input. it stores the date value in miliseconds in the underlying form model. +The date control schema creates a date renderer with an input field and a date picker. To invoke this control, set the `description` property in the `JSONSchema` to `org.joda.time.DateTime`. The form only allows numbers to be input. it stores the date value in milliseconds in the underlying form model. ```ts // Date time Input @@ -143,7 +143,7 @@ const textAreaInputUiSchema: UiSchemaElement = { The select control schema creates a dropdown select box. Users can select only one value from the given list. -Tp invoke this renderer, include an `options` section in the `UISchemaElement` with an array of data. You can specify which properties of your array objects are used for the underlying option value, `valueField`, and for the display value, `labelField`. +To invoke this renderer, include an `options` section in the `UISchemaElement` with an array of data. You can specify which properties of your array objects are used for the underlying option value, `valueField`, and for the display value, `labelField`. ```ts // Select Input diff --git a/docs/04_web/12_forms/08_forms-custom-controls.mdx b/docs/04_web/12_forms/08_forms-custom-controls.mdx index 11fe1bd8c..21ebc04cf 100644 --- a/docs/04_web/12_forms/08_forms-custom-controls.mdx +++ b/docs/04_web/12_forms/08_forms-custom-controls.mdx @@ -13,7 +13,7 @@ tags: # Foundation Forms - custom control renderers -You can create custom control renderers to work alongisde the standard set of foundation form controls. +You can create custom control renderers to work alongside the standard set of foundation form controls. This page guides you through the steps. You need to create a renderer class and a control rank. You then register the custom renderer in your template. diff --git a/examples/ui/client-capabilities/interaction/tree-view.js b/examples/ui/client-capabilities/interaction/tree-view.js new file mode 100644 index 000000000..429552f0d --- /dev/null +++ b/examples/ui/client-capabilities/interaction/tree-view.js @@ -0,0 +1,36 @@ +import { CodeSection } from '../../documentationBase'; +import useIsBrowser from '@docusaurus/useIsBrowser'; +import { MenuItem } from '@genesislcap/rapid-design-system'; + +function ListItem({children}) { + return (
  • {children}
    • ) +} + +export default function MenuDemo({ children, color }) { + + const isBrowser = useIsBrowser(); + + if (isBrowser) { + const RapidImports = require('../../rapidImports'); + RapidImports.registerComponents(); + } + + return ( + + + Root + + Item 1 + Sub-item 1-1 + Sub-item 1-2 + + Item 2 + Sub-item 2-1 + Sub-item 2-2 + + + Item 3 + + + ) +}