wavemaker-dev-mcp 0.1.3 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -52
- package/dist/index.js +108 -177
- package/dist/index.js.map +1 -1
- package/dist/skills/loader.d.ts +36 -0
- package/dist/skills/loader.d.ts.map +1 -0
- package/dist/skills/loader.js +107 -0
- package/dist/skills/loader.js.map +1 -0
- package/package.json +8 -4
- package/skills/components/wm-accordion-pane.md +44 -0
- package/skills/components/wm-accordion.md +43 -0
- package/skills/components/wm-alert-dialog.md +42 -0
- package/skills/components/wm-anchor.md +51 -0
- package/skills/components/wm-audio.md +41 -0
- package/skills/components/wm-button-group.md +36 -0
- package/skills/components/wm-button.md +114 -0
- package/skills/components/wm-calendar.md +54 -0
- package/skills/components/wm-card.md +60 -0
- package/skills/components/wm-carousel.md +43 -0
- package/skills/components/wm-chart.md +104 -0
- package/skills/components/wm-checkbox.md +52 -0
- package/skills/components/wm-checkboxset.md +75 -0
- package/skills/components/wm-chips.md +78 -0
- package/skills/components/wm-composite.md +30 -0
- package/skills/components/wm-confirm-dialog.md +43 -0
- package/skills/components/wm-container.md +100 -0
- package/skills/components/wm-currency.md +69 -0
- package/skills/components/wm-datatable.md +146 -0
- package/skills/components/wm-date-time.md +80 -0
- package/skills/components/wm-date.md +78 -0
- package/skills/components/wm-dialog-body.md +28 -0
- package/skills/components/wm-dialog-container.md +48 -0
- package/skills/components/wm-dialog-content.md +31 -0
- package/skills/components/wm-dialog-footer.md +28 -0
- package/skills/components/wm-dialog-header.md +43 -0
- package/skills/components/wm-dialog.md +40 -0
- package/skills/components/wm-file-upload.md +58 -0
- package/skills/components/wm-footer.md +31 -0
- package/skills/components/wm-form-field.md +81 -0
- package/skills/components/wm-form.md +58 -0
- package/skills/components/wm-grid-column.md +30 -0
- package/skills/components/wm-header.md +31 -0
- package/skills/components/wm-html.md +31 -0
- package/skills/components/wm-icon.md +40 -0
- package/skills/components/wm-iframe-dialog.md +52 -0
- package/skills/components/wm-iframe.md +35 -0
- package/skills/components/wm-label.md +45 -0
- package/skills/components/wm-left-nav.md +35 -0
- package/skills/components/wm-linear-layout-item.md +28 -0
- package/skills/components/wm-linear-layout.md +92 -0
- package/skills/components/wm-list.md +92 -0
- package/skills/components/wm-live-filter.md +50 -0
- package/skills/components/wm-live-form.md +35 -0
- package/skills/components/wm-login-dialog.md +50 -0
- package/skills/components/wm-login.md +39 -0
- package/skills/components/wm-marquee.md +31 -0
- package/skills/components/wm-menu.md +71 -0
- package/skills/components/wm-message.md +41 -0
- package/skills/components/wm-nav-item.md +28 -0
- package/skills/components/wm-nav.md +61 -0
- package/skills/components/wm-number.md +62 -0
- package/skills/components/wm-page-content.md +34 -0
- package/skills/components/wm-page-dialog.md +45 -0
- package/skills/components/wm-page-toast.md +34 -0
- package/skills/components/wm-page.md +34 -0
- package/skills/components/wm-pagination.md +62 -0
- package/skills/components/wm-panel.md +69 -0
- package/skills/components/wm-partial-container.md +32 -0
- package/skills/components/wm-picture.md +46 -0
- package/skills/components/wm-popover.md +51 -0
- package/skills/components/wm-prefab-container.md +29 -0
- package/skills/components/wm-prefab.md +35 -0
- package/skills/components/wm-progress-bar.md +42 -0
- package/skills/components/wm-progress-circle.md +45 -0
- package/skills/components/wm-radioset.md +66 -0
- package/skills/components/wm-rating.md +76 -0
- package/skills/components/wm-rich-text-editor.md +36 -0
- package/skills/components/wm-right-nav.md +32 -0
- package/skills/components/wm-search.md +66 -0
- package/skills/components/wm-select.md +129 -0
- package/skills/components/wm-slider.md +53 -0
- package/skills/components/wm-spinner.md +43 -0
- package/skills/components/wm-tab-pane.md +45 -0
- package/skills/components/wm-table.md +113 -0
- package/skills/components/wm-tabs.md +48 -0
- package/skills/components/wm-text.md +65 -0
- package/skills/components/wm-textarea.md +47 -0
- package/skills/components/wm-tile.md +34 -0
- package/skills/components/wm-time.md +63 -0
- package/skills/components/wm-top-nav.md +31 -0
- package/skills/components/wm-tree.md +41 -0
- package/skills/components/wm-upload.md +42 -0
- package/skills/components/wm-video.md +48 -0
- package/skills/components/wm-wizard.md +59 -0
- package/skills/index.json +1151 -0
- package/skills/tokens/border.md +85 -0
- package/skills/tokens/colors.md +97 -0
- package/skills/tokens/elevation.md +73 -0
- package/skills/tokens/spacing.md +89 -0
- package/skills/tokens/typography.md +88 -0
- package/dist/components.d.ts +0 -17
- package/dist/components.d.ts.map +0 -1
- package/dist/components.js +0 -67
- package/dist/components.js.map +0 -1
- package/dist/paths.d.ts +0 -43
- package/dist/paths.d.ts.map +0 -1
- package/dist/paths.js +0 -103
- package/dist/paths.js.map +0 -1
- package/dist/search.d.ts +0 -15
- package/dist/search.d.ts.map +0 -1
- package/dist/search.js +0 -130
- package/dist/search.js.map +0 -1
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmFormField
|
|
3
|
+
category: data
|
|
4
|
+
import: components/data/form/form-field
|
|
5
|
+
tags: [data, form, field, data-binding, dropdown, form-field]
|
|
6
|
+
summary: Form Field — dropdown data widget bound to a dataset.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmFormField
|
|
11
|
+
|
|
12
|
+
Form Field — dropdown data widget bound to a dataset.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmFormField
|
|
18
|
+
name="formField"
|
|
19
|
+
dataset={items}
|
|
20
|
+
displayfield="label"
|
|
21
|
+
/>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Req | Default | Description |
|
|
27
|
+
|------|------|-----|---------|-------------|
|
|
28
|
+
| readonly | `boolean` | No | — | Whether the field is read-only. |
|
|
29
|
+
| displayname | `string` | No | — | Display name of the field. |
|
|
30
|
+
| type | `string` | No | — | Type of the field. |
|
|
31
|
+
| widget | `string` | No | — | Widget type for the field. |
|
|
32
|
+
| textalign | `string` | No | — | Text alignment within the field. |
|
|
33
|
+
| placeholder | `string` | No | — | Placeholder text for the field. |
|
|
34
|
+
| title | `string` | No | — | Title of the field. |
|
|
35
|
+
| required | `boolean` | No | — | Whether the field is required. |
|
|
36
|
+
| value | `string` | No | — | Current value of the field. |
|
|
37
|
+
| dataentrymode | `string` | No | — | Mode of data entry. |
|
|
38
|
+
| debouncetime | `number` | No | — | Debounce time for input changes. |
|
|
39
|
+
| defaultvalue | `string` | No | — | Default value for the field. |
|
|
40
|
+
| field | `string` | No | — | The underlying data field. |
|
|
41
|
+
| filterexpressions | `string` | No | — | Filter expressions for the field. |
|
|
42
|
+
| generator | `string` | No | — | Generator for the field. |
|
|
43
|
+
| hint | `string` | No | — | Hint text for the field. |
|
|
44
|
+
| inputtype | `string` | No | — | Input type for the field. |
|
|
45
|
+
| isformfield | `boolean` | No | — | Whether this is a form field. |
|
|
46
|
+
| limit | `number` | No | — | Limit for field values. |
|
|
47
|
+
| lookuptype | `string` | No | — | Type of lookup. |
|
|
48
|
+
| lookupfield | `string` | No | — | The field to use for lookups. |
|
|
49
|
+
| matchmode | `string` | No | — | Match mode for filtering. |
|
|
50
|
+
| maxdefaultvalue | `string` | No | — | Maximum default value. |
|
|
51
|
+
| maxplaceholder | `string` | No | — | Maximum placeholder text. |
|
|
52
|
+
| mobileDisplay | `boolean` | No | — | Whether to display on mobile devices. |
|
|
53
|
+
| period | `boolean` | No | — | Whether to use periodic updates. |
|
|
54
|
+
| pcDisplay | `boolean` | No | — | Whether to display on PC. |
|
|
55
|
+
| primaryKey | `boolean` | No | — | Whether this is a primary key field. |
|
|
56
|
+
| relatedEntityName | `string` | No | — | Name of the related entity. |
|
|
57
|
+
| tabletDisplay | `boolean` | No | — | Whether to display on tablet devices. |
|
|
58
|
+
| validationmessage | `string` | No | — | Validation message to display. |
|
|
59
|
+
| viewmodewidget | `string` | No | — | Widget to use in view mode. |
|
|
60
|
+
| widgettype | `string` | No | — | The type of the widget. |
|
|
61
|
+
| datafield | `string` | No | — | Property name to use for the data field. |
|
|
62
|
+
| displayfield | `string` | No | — | Property name to use for the display field. |
|
|
63
|
+
| displaylabel | `string` | No | — | Label for the display field. |
|
|
64
|
+
| dataset | `any[]` | No | — | The collection of data items for the field. |
|
|
65
|
+
| searchkey | `string` | No | — | Key to use for searching. |
|
|
66
|
+
| itemsPerRow | `string` | No | — | Number of items to show per row. |
|
|
67
|
+
| formRef | `any` | No | — | Reference to the parent form. |
|
|
68
|
+
| renderFormFields | `(props: any) => ReactNode` | No | — | Function to render the actual form fields. |
|
|
69
|
+
| id | `string` | No | — | Unique ID for the field. |
|
|
70
|
+
| captionposition | `"left" \| "right" \| "top" \| "floating"` | No | — | Position of the caption. |
|
|
71
|
+
| formKey | `string` | No | — | The form key for this field. |
|
|
72
|
+
| role | `string` | No | — | Role of the field. |
|
|
73
|
+
| updateon | `string` | No | — | Status of when to update the field. |
|
|
74
|
+
| updateFormWidgetDataset | `(dataset: any, displayField?: string) => void` | No | — | Function to update the widget's dataset. |
|
|
75
|
+
| setIsDataSetBound | `(isBound: boolean) => void` | No | — | Function to set whether the dataset is bound. |
|
|
76
|
+
| validators | `[]` | No | — | — |
|
|
77
|
+
| fieldName | `string` | Yes | — | — |
|
|
78
|
+
| formName | `string` | Yes | — | — |
|
|
79
|
+
| parentForm | `string` | No | — | — |
|
|
80
|
+
|
|
81
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmForm
|
|
3
|
+
category: data
|
|
4
|
+
import: components/data/form
|
|
5
|
+
tags: [data, form, icon, collapsible]
|
|
6
|
+
summary: Form data widget.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmForm
|
|
11
|
+
|
|
12
|
+
Form data widget.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmForm
|
|
18
|
+
name="form"
|
|
19
|
+
title="My Panel"
|
|
20
|
+
/>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Req | Default | Description |
|
|
26
|
+
|------|------|-----|---------|-------------|
|
|
27
|
+
| defaultmode | `"create" \| "edit" \| "view"` | No | — | The default mode of the form. |
|
|
28
|
+
| errormessage | `string` | No | — | Error message to display when form submission fails. |
|
|
29
|
+
| captionposition | `"left" \| "right" \| "top" \| "bottom"` | No | — | Position of the captions for form fields. |
|
|
30
|
+
| title | `string` | No | — | Title of the form. |
|
|
31
|
+
| enctype | `string` | No | — | Encoding type for the form. |
|
|
32
|
+
| method | `"post" \| "put" \| "delete"` | No | — | HTTP method for form submission. |
|
|
33
|
+
| captionalign | `"left" \| "center" \| "right"` | No | — | The alignment of the captions. |
|
|
34
|
+
| subheading | `string` | No | — | Subheading of the form. |
|
|
35
|
+
| iconclass | `string` | No | — | CSS class for the form icon. |
|
|
36
|
+
| autocomplete | `boolean` | No | — | Whether to enable autocomplete for the form. |
|
|
37
|
+
| collapsible | `boolean` | No | — | Whether the form is collapsible. |
|
|
38
|
+
| expanded | `boolean` | No | — | Whether the form is expanded by default (if collapsible). |
|
|
39
|
+
| formdatasource | `string` | No | — | Data source for the form. |
|
|
40
|
+
| numberoffields | `number` | No | — | Number of fields/columns in the form layout. |
|
|
41
|
+
| formType | `string` | No | — | Type of the form. |
|
|
42
|
+
| isViewMode | `boolean` | No | — | Whether the form is currently in view mode. |
|
|
43
|
+
| isLayoutDialog | `boolean` | No | — | Whether the form is part of a layout dialog. |
|
|
44
|
+
| isInsideWizard | `boolean` | No | — | Whether the form is inside a wizard component. |
|
|
45
|
+
| validationtype | `string` | No | — | Type of validation to apply. |
|
|
46
|
+
| id | `string` | No | — | The unique ID for the form. |
|
|
47
|
+
| metadata | `any[]` | No | — | Metadata for the form fields. |
|
|
48
|
+
| submit | `(e?: any) => Promise<boolean \| undefined>` | No | — | Callback for form submission. |
|
|
49
|
+
| formreset | `() => Promise<void>` | No | — | Callback for resetting the form. |
|
|
50
|
+
| formElementRef | `Ref<HTMLFormElement>` | No | — | Ref for the HTML form element. |
|
|
51
|
+
| headerActions | `any[]` | No | — | Actions to display in the form header. |
|
|
52
|
+
| expandCollapsePanel | `() => void` | No | — | Function to handle expansion/collapse of the form. |
|
|
53
|
+
| showmessage | `boolean` | No | — | Whether to show the status message. |
|
|
54
|
+
| messagelayout | `"Inline" \| "Toaster"` | No | — | Layout for the status message. |
|
|
55
|
+
| statusMessage | `{ caption?: string; type?: string; }` | No | — | The status message to display. |
|
|
56
|
+
| clearMessage | `() => void` | No | — | Callback to clear the status message. |
|
|
57
|
+
|
|
58
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmGridColumn
|
|
3
|
+
category: container
|
|
4
|
+
import: components/container/layout-grid/grid-column
|
|
5
|
+
tags: [container, grid, column]
|
|
6
|
+
summary: Grid Column layout container.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmGridColumn
|
|
11
|
+
|
|
12
|
+
Grid Column layout container.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmGridColumn
|
|
18
|
+
name="gridColumn"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| columnwidth | `number` | No | — | Bootstrap-style column width (e.g., 1-12 for col-sm-1 to col-sm-12). |
|
|
27
|
+
| horizontalalign | `GridColumnHorizontalAlign` | No | `"right"` | Horizontal alignment of column content. |
|
|
28
|
+
| containerProps | `Record<string, unknown>` | No | — | Props passed to the underlying Container component. |
|
|
29
|
+
|
|
30
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmHeader
|
|
3
|
+
category: layout
|
|
4
|
+
import: components/layout/header
|
|
5
|
+
tags: [layout, header]
|
|
6
|
+
summary: Header page layout component.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmHeader
|
|
11
|
+
|
|
12
|
+
Header page layout component.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmHeader
|
|
18
|
+
name="header"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| children | `ReactNode` | No | — | — |
|
|
27
|
+
| className | `string` | No | — | — |
|
|
28
|
+
| styles | `CSSProperties` | No | — | — |
|
|
29
|
+
| id | `string` | No | — | — |
|
|
30
|
+
|
|
31
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmHtml
|
|
3
|
+
category: basic
|
|
4
|
+
import: components/basic/html
|
|
5
|
+
tags: [basic, html]
|
|
6
|
+
summary: Html display widget.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmHtml
|
|
11
|
+
|
|
12
|
+
Html display widget.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmHtml
|
|
18
|
+
name="html"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| content | `string \| object` | Yes | — | The HTML content to be displayed. Can be a string, object (for trusted content), or React element. |
|
|
27
|
+
| horizontalalign | `"left" \| "center" \| "right"` | No | `"left"` | The horizontal alignment of the content. |
|
|
28
|
+
| trustAs | `boolean` | No | `false` | If true, the content will be rendered as HTML without strict sanitation (though DOMPurify is still used). |
|
|
29
|
+
| id | `string` | No | — | — |
|
|
30
|
+
|
|
31
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmIcon
|
|
3
|
+
category: basic
|
|
4
|
+
import: components/basic/icon
|
|
5
|
+
tags: [basic, icon, caption]
|
|
6
|
+
summary: Icon display widget.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmIcon
|
|
11
|
+
|
|
12
|
+
Icon display widget.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmIcon
|
|
18
|
+
name="icon"
|
|
19
|
+
caption="My Icon"
|
|
20
|
+
/>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Req | Default | Description |
|
|
26
|
+
|------|------|-----|---------|-------------|
|
|
27
|
+
| caption | `string` | No | — | The text to be displayed as a caption for the icon. |
|
|
28
|
+
| iconclass | `string` | Yes | `"wm-sl-l sl-user"` | The CSS class for the icon. |
|
|
29
|
+
| iconurl | `string` | No | — | The URL of the icon image. |
|
|
30
|
+
| iconposition | `"left" \| "right"` | No | `"left"` | The position of the icon relative to the caption. |
|
|
31
|
+
| iconsize | `string` | No | — | The size (width/height/font-size) of the icon. |
|
|
32
|
+
| variant | `VariantType` | No | `"default:md"` | The variant of the icon. |
|
|
33
|
+
|
|
34
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
35
|
+
|
|
36
|
+
## CSS Tokens
|
|
37
|
+
|
|
38
|
+
Component-specific CSS variables: `--wm-icon-*`
|
|
39
|
+
|
|
40
|
+
See foundation-css: `src/tokens/web/components/icon/icon.json`
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmIframeDialog
|
|
3
|
+
category: dialogs
|
|
4
|
+
import: components/dialogs/iframe-dialog
|
|
5
|
+
tags: [dialogs, iframe, dialog, icon]
|
|
6
|
+
summary: Iframe Dialog — modal dialog.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmIframeDialog
|
|
11
|
+
|
|
12
|
+
Iframe Dialog — modal dialog.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmIframeDialog
|
|
18
|
+
name="iframeDialog"
|
|
19
|
+
title="My Panel"
|
|
20
|
+
/>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Req | Default | Description |
|
|
26
|
+
|------|------|-----|---------|-------------|
|
|
27
|
+
| open | `boolean` | No | — | Whether the dialog is open. |
|
|
28
|
+
| closable | `boolean` | No | — | Whether the dialog can be dismissed by the user. |
|
|
29
|
+
| modal | `boolean` | No | — | When `true`, blocks backdrop click and disables escape close. |
|
|
30
|
+
| title | `string` | No | — | Title text for the iframe dialog. |
|
|
31
|
+
| headinglevel | `"h1" \| "h2" \| "h4"` | No | — | Heading level for the title. |
|
|
32
|
+
| iconclass | `string` | No | — | CSS class for the header icon. |
|
|
33
|
+
| iconurl | `string` | No | — | URL for the header icon. |
|
|
34
|
+
| iconwidth | `string` | No | — | Width of the header icon. |
|
|
35
|
+
| iconheight | `string` | No | — | Height of the header icon. |
|
|
36
|
+
| iconmargin | `string` | No | — | Margin for the header icon. |
|
|
37
|
+
| oktext | `string` | No | — | Text for the OK button. |
|
|
38
|
+
| showheader | `boolean` | No | — | Whether to show the dialog header. |
|
|
39
|
+
| showactions | `boolean` | No | — | Whether to show the dialog actions (footer). |
|
|
40
|
+
| url | `string` | No | — | URL for the iframe content. |
|
|
41
|
+
| encodeurl | `boolean` | No | — | Whether to encode the URL. |
|
|
42
|
+
| onClose | `(event?: SyntheticEvent) => void` | No | — | Callback fired when the dialog requests to be closed. |
|
|
43
|
+
| onOk | `(event: SyntheticEvent \| MouseEvent) => void` | No | — | Callback fired when the OK button is clicked. |
|
|
44
|
+
| widgetId | `string` | No | — | Unique identifier for the widget. |
|
|
45
|
+
|
|
46
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
47
|
+
|
|
48
|
+
## CSS Tokens
|
|
49
|
+
|
|
50
|
+
Component-specific CSS variables: `--wm-iframe-dialog-*`
|
|
51
|
+
|
|
52
|
+
See foundation-css: `src/tokens/web/components/modal-dialog/modal-dialog.json`
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmIframe
|
|
3
|
+
category: basic
|
|
4
|
+
import: components/basic/iframe
|
|
5
|
+
tags: [basic, iframe]
|
|
6
|
+
summary: Iframe display widget.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmIframe
|
|
11
|
+
|
|
12
|
+
Iframe display widget.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmIframe
|
|
18
|
+
name="iframe"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| iframesrc | `string` | Yes | — | The source URL for the iframe. |
|
|
27
|
+
| encodeurl | `boolean` | No | `false` | If true, the source URL will be encoded. |
|
|
28
|
+
|
|
29
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
30
|
+
|
|
31
|
+
## CSS Tokens
|
|
32
|
+
|
|
33
|
+
Component-specific CSS variables: `--wm-iframe-*`
|
|
34
|
+
|
|
35
|
+
See foundation-css: `src/tokens/web/components/iframe/iframe.json`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmLabel
|
|
3
|
+
category: basic
|
|
4
|
+
import: components/basic/label
|
|
5
|
+
tags: [basic, label, caption, form-field]
|
|
6
|
+
summary: Label display widget.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmLabel
|
|
11
|
+
|
|
12
|
+
Label display widget.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmLabel
|
|
18
|
+
name="label"
|
|
19
|
+
caption="My Label"
|
|
20
|
+
/>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Props
|
|
24
|
+
|
|
25
|
+
| Prop | Type | Req | Default | Description |
|
|
26
|
+
|------|------|-----|---------|-------------|
|
|
27
|
+
| caption | `string \| object` | No | — | The text or object to be displayed as the label caption.
|
|
28
|
+
If an object is provided, it will be stringified.
|
|
29
|
+
Supports basic markdown-like link syntax: [text](url). |
|
|
30
|
+
| required | `boolean` | No | `false` | If true, a red asterisk will be shown next to the label indicating it's a required field. |
|
|
31
|
+
| trustAs | `boolean` | No | `false` | If true, the caption will be rendered as HTML.
|
|
32
|
+
Use with caution as it can lead to XSS if the content is not trusted. |
|
|
33
|
+
| type | `ValidTagType` | No | `"p"` | The HTML tag to use for rendering the label. |
|
|
34
|
+
| id | `string` | No | — | The unique ID for the label element. |
|
|
35
|
+
| htmlFor | `string` | No | — | The ID of the form element this label is associated with. |
|
|
36
|
+
| variant | `TextTagType \| LabelTagType \| VariantType` | No | `"default:p"` | The variant of the label. |
|
|
37
|
+
| notag | `boolean \| "true" \| "false"` | No | — | — |
|
|
38
|
+
|
|
39
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
40
|
+
|
|
41
|
+
## CSS Tokens
|
|
42
|
+
|
|
43
|
+
Component-specific CSS variables: `--wm-label-*`
|
|
44
|
+
|
|
45
|
+
See foundation-css: `src/tokens/web/components/label/label.json`
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmLeftNav
|
|
3
|
+
category: layout
|
|
4
|
+
import: components/layout/leftnav
|
|
5
|
+
tags: [layout, left, nav]
|
|
6
|
+
summary: Left Nav page layout component.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmLeftNav
|
|
11
|
+
|
|
12
|
+
Left Nav page layout component.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmLeftNav
|
|
18
|
+
name="leftNav"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| columnwidth | `number \| string` | No | `2` | The number of columns the left panel should span. |
|
|
27
|
+
| navheight | `string` | No | — | The height of the navigation panel. |
|
|
28
|
+
| navtype | `string` | No | — | The type of the navigation panel. |
|
|
29
|
+
| onNavHeightChange | `(isFull: boolean) => void` | No | — | Callback function that is called when the navigation height changes. |
|
|
30
|
+
| children | `ReactNode` | No | — | — |
|
|
31
|
+
| className | `string` | No | — | — |
|
|
32
|
+
| styles | `CSSProperties` | No | — | — |
|
|
33
|
+
| id | `string` | No | — | — |
|
|
34
|
+
|
|
35
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmLinearLayoutItem
|
|
3
|
+
category: container
|
|
4
|
+
import: components/container/linear-layout/linear-layout-item
|
|
5
|
+
tags: [container, linear, layout, item]
|
|
6
|
+
summary: Linear Layout Item layout container.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmLinearLayoutItem
|
|
11
|
+
|
|
12
|
+
Linear Layout Item layout container.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmLinearLayoutItem
|
|
18
|
+
name="linearLayoutItem"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Props
|
|
23
|
+
|
|
24
|
+
| Prop | Type | Req | Default | Description |
|
|
25
|
+
|------|------|-----|---------|-------------|
|
|
26
|
+
| flexgrow | `number` | No | — | Flex grow factor. Controls how much the item grows relative to siblings. |
|
|
27
|
+
|
|
28
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmLinearLayout
|
|
3
|
+
category: container
|
|
4
|
+
import: components/container/linear-layout
|
|
5
|
+
tags: [layout, flex, row, column, horizontal, vertical, container, autolayout, spacing]
|
|
6
|
+
summary: Flex-based directional layout. Primary container for arranging children in a row or column with consistent spacing.
|
|
7
|
+
related: [WmLinearLayoutItem, WmContainer, WmLayoutGrid]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmLinearLayout
|
|
11
|
+
|
|
12
|
+
Primary layout container for arranging children horizontally or vertically using flexbox. Always pair with `WmLinearLayoutItem` children — direct content without a wrapper item may not space correctly.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmLinearLayout name="headerRow" direction="row" spacing={12} horizontalalign="left" verticalalign="center">
|
|
18
|
+
<WmLinearLayoutItem name="headerRow_item1">
|
|
19
|
+
<WmLabel name="title" caption="Dashboard" />
|
|
20
|
+
</WmLinearLayoutItem>
|
|
21
|
+
<WmLinearLayoutItem name="headerRow_item2">
|
|
22
|
+
<WmButton name="addBtn" caption="Add" />
|
|
23
|
+
</WmLinearLayoutItem>
|
|
24
|
+
</WmLinearLayout>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Key Props
|
|
28
|
+
|
|
29
|
+
| Prop | Type | Default | Description |
|
|
30
|
+
|------|------|---------|-------------|
|
|
31
|
+
| direction | `"row" \| "row-reverse" \| "column" \| "column-reverse"` | `"column"` | Flex direction for children |
|
|
32
|
+
| spacing | `string \| number` | — | Gap between items (use token values: 3=xs, 6=sm, 12=md, 18=lg, 24=xl) |
|
|
33
|
+
| horizontalalign | `"left" \| "right" \| "center"` | `"left"` | Horizontal alignment of children |
|
|
34
|
+
| verticalalign | `"top" \| "bottom" \| "center"` | `"top"` | Vertical alignment of children |
|
|
35
|
+
| name | `string` | — | Required. Widget identifier |
|
|
36
|
+
| show | `boolean` | `true` | Visibility toggle |
|
|
37
|
+
| width | `string` | — | CSS width (e.g. `"100%"`, `"200px"`) |
|
|
38
|
+
| height | `string` | — | CSS height |
|
|
39
|
+
| padding | `string` | — | CSS padding shorthand |
|
|
40
|
+
| className | `string` | — | Additional CSS class names |
|
|
41
|
+
|
|
42
|
+
## Spacing Token Map
|
|
43
|
+
|
|
44
|
+
| Token | spacing value | Gap (px) |
|
|
45
|
+
|-------|--------------|----------|
|
|
46
|
+
| xs | 3 | 4px |
|
|
47
|
+
| sm | 6 | 8px |
|
|
48
|
+
| md | 12 | 16px |
|
|
49
|
+
| lg | 18 | 24px |
|
|
50
|
+
| xl | 24 | 32px |
|
|
51
|
+
|
|
52
|
+
## Patterns
|
|
53
|
+
|
|
54
|
+
**Row of buttons:**
|
|
55
|
+
```jsx
|
|
56
|
+
<WmLinearLayout name="actions" direction="row" spacing={12} verticalalign="center">
|
|
57
|
+
<WmLinearLayoutItem name="actions_item1">
|
|
58
|
+
<WmButton name="saveBtn" caption="Save" />
|
|
59
|
+
</WmLinearLayoutItem>
|
|
60
|
+
<WmLinearLayoutItem name="actions_item2">
|
|
61
|
+
<WmButton name="cancelBtn" caption="Cancel" />
|
|
62
|
+
</WmLinearLayoutItem>
|
|
63
|
+
</WmLinearLayout>
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Full-width vertical stack:**
|
|
67
|
+
```jsx
|
|
68
|
+
<WmLinearLayout name="pageBody" direction="column" spacing={18} width="100%">
|
|
69
|
+
<WmLinearLayoutItem name="pageBody_item1">
|
|
70
|
+
<WmContainer name="section1" />
|
|
71
|
+
</WmLinearLayoutItem>
|
|
72
|
+
<WmLinearLayoutItem name="pageBody_item2">
|
|
73
|
+
<WmContainer name="section2" />
|
|
74
|
+
</WmLinearLayoutItem>
|
|
75
|
+
</WmLinearLayout>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**Centered content:**
|
|
79
|
+
```jsx
|
|
80
|
+
<WmLinearLayout name="center" direction="row" horizontalalign="center" verticalalign="center" width="100%" height="100%">
|
|
81
|
+
<WmLinearLayoutItem name="center_item1">
|
|
82
|
+
<WmLabel name="msg" caption="No data found" />
|
|
83
|
+
</WmLinearLayoutItem>
|
|
84
|
+
</WmLinearLayout>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Notes
|
|
88
|
+
|
|
89
|
+
- `WmLinearLayoutItem` has no visual props of its own — it is purely a structural wrapper.
|
|
90
|
+
- Use `direction="row"` with `verticalalign="center"` for icon+label combos.
|
|
91
|
+
- Prefer `spacing` over manual padding/margin on items for consistent token-aligned gaps.
|
|
92
|
+
- For complex grid layouts (multi-column), use `WmLayoutGrid` instead.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
component: WmList
|
|
3
|
+
category: data
|
|
4
|
+
import: components/data/list
|
|
5
|
+
tags: [data, list, data-binding, pagination, icon, collapsible, dropdown]
|
|
6
|
+
summary: List — dropdown data widget bound to a dataset.
|
|
7
|
+
generated: true
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# WmList
|
|
11
|
+
|
|
12
|
+
List — dropdown data widget bound to a dataset.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```jsx
|
|
17
|
+
<WmList
|
|
18
|
+
name="list"
|
|
19
|
+
dataset={items}
|
|
20
|
+
displayfield="label"
|
|
21
|
+
/>
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
| Prop | Type | Req | Default | Description |
|
|
27
|
+
|------|------|-----|---------|-------------|
|
|
28
|
+
| boundarylinks | `boolean` | No | — | Whether to show boundary links in pagination. |
|
|
29
|
+
| collapsible | `boolean` | No | — | Whether the list items are collapsible. |
|
|
30
|
+
| dateformat | `string` | No | — | Date format for list items. |
|
|
31
|
+
| dataset | `T[]` | No | — | The collection of data items to display. |
|
|
32
|
+
| datasource | `LiveVariableConfig` | No | — | The data source for the list. |
|
|
33
|
+
| direction | `IDirection` | No | `"vertical"` | The layout direction of the list. |
|
|
34
|
+
| disableitem | `boolean` | No | — | Whether to disable list items. |
|
|
35
|
+
| enablereorder | `boolean` | No | — | Whether to enable reordering of list items. |
|
|
36
|
+
| groupby | `string` | No | — | Property name to group the list items by. |
|
|
37
|
+
| iconclass | `string` | No | — | CSS class for the list icon. |
|
|
38
|
+
| itemclass | `string \| ((item: T) => string \| null \| undefined)` | No | — | CSS class or function returning a class for each list item. |
|
|
39
|
+
| itemsperrow | `string` | No | — | Number of items to show per row in grid layout. |
|
|
40
|
+
| listclass | `string` | No | — | CSS class for the list container. |
|
|
41
|
+
| horizontalalign | `IAlignment` | No | — | Horizontal alignment of the list. |
|
|
42
|
+
| columnalign | `IColumnAlignment` | No | — | Column alignment of the list items. |
|
|
43
|
+
| multiselect | `boolean` | No | — | Whether to allow multiple items to be selected. |
|
|
44
|
+
| loadingdatamsg | `string` | No | — | Message to display while loading data. |
|
|
45
|
+
| loadingicon | `string` | No | — | CSS class for the loading icon. |
|
|
46
|
+
| maxsize | `number` | No | — | Maximum size of the collection. |
|
|
47
|
+
| statehandler | `StorageType` | No | — | State persistence handler type. |
|
|
48
|
+
| navigation | `INavigation` | No | — | The type of navigation/pagination to use. |
|
|
49
|
+
| navigationalign | `IAlignment` | No | — | Alignment of the navigation controls. |
|
|
50
|
+
| nodatamessage | `string` | No | — | Message to display when no data is found. |
|
|
51
|
+
| ondemandmessage | `string` | No | — | Message to display for On-Demand loading. |
|
|
52
|
+
| orderby | `string` | No | — | Property name to order the list items by. |
|
|
53
|
+
| paginationclass | `string` | No | — | CSS class for the pagination controls. |
|
|
54
|
+
| pagesize | `number` | No | — | Number of items per page. |
|
|
55
|
+
| selectfirstitem | `boolean` | No | — | Whether to automatically select the first item on load. |
|
|
56
|
+
| selectionlimit | `number` | No | — | Maximum number of items that can be selected. |
|
|
57
|
+
| showcount | `boolean` | No | — | Whether to show the item count. |
|
|
58
|
+
| showrecordcount | `boolean` | No | — | Whether to show the record count. |
|
|
59
|
+
| allowpagesizechange | `boolean` | No | — | Whether to allow the user to change the page size. |
|
|
60
|
+
| pagesizeoptions | `string` | No | — | Available page size options. |
|
|
61
|
+
| subheading | `string` | No | — | Subheading of the list. |
|
|
62
|
+
| title | `string` | No | — | Title of the list. |
|
|
63
|
+
| hidehorizontalscrollbar | `boolean` | No | — | Whether to hide the horizontal scrollbar. |
|
|
64
|
+
| selectedItemWidgets | `Array<any> \| any` | No | — | Widgets for the currently selected item. |
|
|
65
|
+
| onSelect | `ListSelectHandler<T>` | No | — | Callback for selection event. |
|
|
66
|
+
| onClick | `ListItemEventHandler` | No | — | Callback for click event on a list item. |
|
|
67
|
+
| onDblclick | `ListItemEventHandler` | No | — | Callback for double click event on a list item. |
|
|
68
|
+
| onMouseEnter | `ListItemEventHandler` | No | — | Callback for mouse enter event on a list item. |
|
|
69
|
+
| onMouseLeave | `ListItemEventHandler` | No | — | Callback for mouse leave event on a list item. |
|
|
70
|
+
| onReorder | `ListReorderEventHandler<T>` | No | — | Callback for reorder event. |
|
|
71
|
+
| onSelectionlimitexceed | `ListSelectionLimitExceededHandler` | No | — | Callback for when selection limit is exceeded. |
|
|
72
|
+
| onBeforedatarender | `ListBeforeDataRenderHandler<T>` | No | — | Callback before data is rendered. |
|
|
73
|
+
| onRender | `ListBeforeDataRenderHandler<T>` | No | — | Callback after data is rendered. |
|
|
74
|
+
| onPaginationchange | `ListPaginationChangeHandler` | No | — | Callback for pagination change event. |
|
|
75
|
+
| onSetrecord | `ListSetRecordHandler<T>` | No | — | Callback for setting a record. |
|
|
76
|
+
| onPageChange | `ListPageEventHandler` | No | — | Callback for page change event. |
|
|
77
|
+
| renderItem | `ListRenderItemHandler<T>` | No | — | Custom render function for list items. |
|
|
78
|
+
| tabIndex | `number` | No | — | Tab index of the list. |
|
|
79
|
+
| pulltorefresh | `boolean` | No | — | Whether to enable pull-to-refresh functionality. |
|
|
80
|
+
| datafield | `string` | No | — | Property name to use for the data field. |
|
|
81
|
+
| displayfield | `string` | No | — | Property name to use for the display field. |
|
|
82
|
+
| getDisplayExpression | `(data: T, index?: number) => string` | No | — | Function to get the display expression for an item. |
|
|
83
|
+
| displaylabel | `string` | No | — | Label for the display field. |
|
|
84
|
+
| showNavigation | `boolean` | No | — | Whether to show navigation controls. |
|
|
85
|
+
|
|
86
|
+
*Inherits BaseProps: `name`, `show`, `className`, `width`, `height`, `padding`, `margin`, `onClick`, and more.*
|
|
87
|
+
|
|
88
|
+
## CSS Tokens
|
|
89
|
+
|
|
90
|
+
Component-specific CSS variables: `--wm-list-*`
|
|
91
|
+
|
|
92
|
+
See foundation-css: `src/tokens/web/components/list/list.json`
|