This is page 32 of 141. Use http://codebase.md/xmlui-org/xmlui/mockApiDef.js?page={x} to view the full context.
# Directory Structure
```
├── .changeset
│ └── config.json
├── .eslintrc.cjs
├── .github
│ ├── build-checklist.png
│ ├── ISSUE_TEMPLATE
│ │ ├── bug_report.md
│ │ └── feature_request.md
│ └── workflows
│ ├── deploy-blog.yml
│ ├── deploy-docs-optimized.yml
│ ├── deploy-docs.yml
│ ├── prepare-versions.yml
│ ├── release-packages.yml
│ ├── run-all-tests.yml
│ └── run-smoke-tests.yml
├── .gitignore
├── .prettierrc.js
├── .vscode
│ ├── launch.json
│ └── settings.json
├── blog
│ ├── .gitignore
│ ├── .gitkeep
│ ├── CHANGELOG.md
│ ├── extensions.ts
│ ├── index.html
│ ├── index.ts
│ ├── layout-changes.md
│ ├── package.json
│ ├── public
│ │ ├── blog
│ │ │ ├── images
│ │ │ │ ├── blog-page-component.png
│ │ │ │ ├── blog-scrabble.png
│ │ │ │ ├── integrated-blog-search.png
│ │ │ │ └── lorem-ipsum.png
│ │ │ ├── lorem-ipsum.md
│ │ │ ├── newest-post.md
│ │ │ ├── older-post.md
│ │ │ └── welcome-to-the-xmlui-blog.md
│ │ ├── mockServiceWorker.js
│ │ ├── resources
│ │ │ ├── favicon.ico
│ │ │ ├── files
│ │ │ │ └── for-download
│ │ │ │ └── xmlui
│ │ │ │ └── xmlui-standalone.umd.js
│ │ │ ├── github.svg
│ │ │ ├── llms.txt
│ │ │ ├── logo-dark.svg
│ │ │ ├── logo.svg
│ │ │ ├── pg-popout.svg
│ │ │ ├── rss.svg
│ │ │ └── xmlui-logo.svg
│ │ ├── serve.json
│ │ └── web.config
│ ├── scripts
│ │ ├── download-latest-xmlui.js
│ │ ├── generate-rss.js
│ │ ├── get-releases.js
│ │ └── utils.js
│ ├── src
│ │ ├── components
│ │ │ ├── BlogOverview.xmlui
│ │ │ ├── BlogPage.xmlui
│ │ │ └── PageNotFound.xmlui
│ │ ├── config.ts
│ │ ├── Main.xmlui
│ │ └── themes
│ │ └── blog-theme.ts
│ └── tsconfig.json
├── CONTRIBUTING.md
├── docs
│ ├── .gitignore
│ ├── CHANGELOG.md
│ ├── ComponentRefLinks.txt
│ ├── content
│ │ ├── _meta.json
│ │ ├── components
│ │ │ ├── _meta.json
│ │ │ ├── _overview.md
│ │ │ ├── APICall.md
│ │ │ ├── App.md
│ │ │ ├── AppHeader.md
│ │ │ ├── AppState.md
│ │ │ ├── AutoComplete.md
│ │ │ ├── Avatar.md
│ │ │ ├── Backdrop.md
│ │ │ ├── Badge.md
│ │ │ ├── BarChart.md
│ │ │ ├── Bookmark.md
│ │ │ ├── Breakout.md
│ │ │ ├── Button.md
│ │ │ ├── Card.md
│ │ │ ├── Carousel.md
│ │ │ ├── ChangeListener.md
│ │ │ ├── Checkbox.md
│ │ │ ├── CHStack.md
│ │ │ ├── ColorPicker.md
│ │ │ ├── Column.md
│ │ │ ├── ContentSeparator.md
│ │ │ ├── CVStack.md
│ │ │ ├── DataSource.md
│ │ │ ├── DateInput.md
│ │ │ ├── DatePicker.md
│ │ │ ├── DonutChart.md
│ │ │ ├── DropdownMenu.md
│ │ │ ├── EmojiSelector.md
│ │ │ ├── ExpandableItem.md
│ │ │ ├── FileInput.md
│ │ │ ├── FileUploadDropZone.md
│ │ │ ├── FlowLayout.md
│ │ │ ├── Footer.md
│ │ │ ├── Form.md
│ │ │ ├── FormItem.md
│ │ │ ├── FormSection.md
│ │ │ ├── Fragment.md
│ │ │ ├── H1.md
│ │ │ ├── H2.md
│ │ │ ├── H3.md
│ │ │ ├── H4.md
│ │ │ ├── H5.md
│ │ │ ├── H6.md
│ │ │ ├── Heading.md
│ │ │ ├── HSplitter.md
│ │ │ ├── HStack.md
│ │ │ ├── Icon.md
│ │ │ ├── IFrame.md
│ │ │ ├── Image.md
│ │ │ ├── Items.md
│ │ │ ├── LabelList.md
│ │ │ ├── Legend.md
│ │ │ ├── LineChart.md
│ │ │ ├── Link.md
│ │ │ ├── List.md
│ │ │ ├── Logo.md
│ │ │ ├── Markdown.md
│ │ │ ├── MenuItem.md
│ │ │ ├── MenuSeparator.md
│ │ │ ├── ModalDialog.md
│ │ │ ├── NavGroup.md
│ │ │ ├── NavLink.md
│ │ │ ├── NavPanel.md
│ │ │ ├── NoResult.md
│ │ │ ├── NumberBox.md
│ │ │ ├── Option.md
│ │ │ ├── Page.md
│ │ │ ├── PageMetaTitle.md
│ │ │ ├── Pages.md
│ │ │ ├── Pagination.md
│ │ │ ├── PasswordInput.md
│ │ │ ├── PieChart.md
│ │ │ ├── ProgressBar.md
│ │ │ ├── Queue.md
│ │ │ ├── RadioGroup.md
│ │ │ ├── RealTimeAdapter.md
│ │ │ ├── Redirect.md
│ │ │ ├── Select.md
│ │ │ ├── Slider.md
│ │ │ ├── Slot.md
│ │ │ ├── SpaceFiller.md
│ │ │ ├── Spinner.md
│ │ │ ├── Splitter.md
│ │ │ ├── Stack.md
│ │ │ ├── StickyBox.md
│ │ │ ├── SubMenuItem.md
│ │ │ ├── Switch.md
│ │ │ ├── TabItem.md
│ │ │ ├── Table.md
│ │ │ ├── TableOfContents.md
│ │ │ ├── Tabs.md
│ │ │ ├── Text.md
│ │ │ ├── TextArea.md
│ │ │ ├── TextBox.md
│ │ │ ├── Theme.md
│ │ │ ├── TimeInput.md
│ │ │ ├── Timer.md
│ │ │ ├── ToneChangerButton.md
│ │ │ ├── ToneSwitch.md
│ │ │ ├── Tooltip.md
│ │ │ ├── Tree.md
│ │ │ ├── VSplitter.md
│ │ │ ├── VStack.md
│ │ │ ├── xmlui-animations
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ ├── Animation.md
│ │ │ │ ├── FadeAnimation.md
│ │ │ │ ├── FadeInAnimation.md
│ │ │ │ ├── FadeOutAnimation.md
│ │ │ │ ├── ScaleAnimation.md
│ │ │ │ └── SlideInAnimation.md
│ │ │ ├── xmlui-pdf
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ └── Pdf.md
│ │ │ ├── xmlui-spreadsheet
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ └── Spreadsheet.md
│ │ │ └── xmlui-website-blocks
│ │ │ ├── _meta.json
│ │ │ ├── _overview.md
│ │ │ ├── Carousel.md
│ │ │ ├── HelloMd.md
│ │ │ ├── HeroSection.md
│ │ │ └── ScrollToTop.md
│ │ └── extensions
│ │ ├── _meta.json
│ │ ├── xmlui-animations
│ │ │ ├── _meta.json
│ │ │ ├── _overview.md
│ │ │ ├── Animation.md
│ │ │ ├── FadeAnimation.md
│ │ │ ├── FadeInAnimation.md
│ │ │ ├── FadeOutAnimation.md
│ │ │ ├── ScaleAnimation.md
│ │ │ └── SlideInAnimation.md
│ │ └── xmlui-website-blocks
│ │ ├── _meta.json
│ │ ├── _overview.md
│ │ ├── Carousel.md
│ │ ├── HelloMd.md
│ │ ├── HeroSection.md
│ │ └── ScrollToTop.md
│ ├── extensions.ts
│ ├── index.html
│ ├── index.ts
│ ├── package.json
│ ├── public
│ │ ├── feed.rss
│ │ ├── mockServiceWorker.js
│ │ ├── pages
│ │ │ ├── _meta.json
│ │ │ ├── app-structure.md
│ │ │ ├── build-editor-component.md
│ │ │ ├── build-hello-world-component.md
│ │ │ ├── components-intro.md
│ │ │ ├── context-variables.md
│ │ │ ├── forms.md
│ │ │ ├── globals.md
│ │ │ ├── glossary.md
│ │ │ ├── helper-tags.md
│ │ │ ├── hosted-deployment.md
│ │ │ ├── howto
│ │ │ │ ├── assign-a-complex-json-literal-to-a-component-variable.md
│ │ │ │ ├── chain-a-refetch.md
│ │ │ │ ├── debug-a-component.md
│ │ │ │ ├── delay-a-datasource-until-another-datasource-is-ready.md
│ │ │ │ ├── delegate-a-method.md
│ │ │ │ ├── do-custom-form-validation.md
│ │ │ │ ├── expose-a-method-from-a-component.md
│ │ │ │ ├── filter-and-transform-data-from-an-api.md
│ │ │ │ ├── group-items-in-list-by-a-property.md
│ │ │ │ ├── handle-background-operations.md
│ │ │ │ ├── hide-an-element-until-its-datasource-is-ready.md
│ │ │ │ ├── make-a-set-of-equal-width-cards.md
│ │ │ │ ├── make-a-table-responsive.md
│ │ │ │ ├── make-navpanel-width-responsive.md
│ │ │ │ ├── modify-a-value-reported-in-a-column.md
│ │ │ │ ├── paginate-a-list.md
│ │ │ │ ├── pass-data-to-a-modal-dialog.md
│ │ │ │ ├── react-to-button-click-not-keystrokes.md
│ │ │ │ ├── set-the-initial-value-of-a-select-from-fetched-data.md
│ │ │ │ ├── share-a-modaldialog-across-components.md
│ │ │ │ ├── sync-selections-between-table-and-list-views.md
│ │ │ │ ├── update-ui-optimistically.md
│ │ │ │ ├── use-built-in-form-validation.md
│ │ │ │ └── use-the-same-modaldialog-to-add-or-edit.md
│ │ │ ├── howto.md
│ │ │ ├── intro.md
│ │ │ ├── layout.md
│ │ │ ├── markup.md
│ │ │ ├── mcp.md
│ │ │ ├── modal-dialogs.md
│ │ │ ├── news-and-reviews.md
│ │ │ ├── reactive-intro.md
│ │ │ ├── refactoring.md
│ │ │ ├── routing-and-links.md
│ │ │ ├── samples
│ │ │ │ ├── color-palette.xmlui
│ │ │ │ ├── color-values.xmlui
│ │ │ │ ├── shadow-sizes.xmlui
│ │ │ │ ├── spacing-sizes.xmlui
│ │ │ │ ├── swatch.xmlui
│ │ │ │ ├── theme-gallery-brief.xmlui
│ │ │ │ └── theme-gallery.xmlui
│ │ │ ├── scoping.md
│ │ │ ├── scripting.md
│ │ │ ├── styles-and-themes
│ │ │ │ ├── common-units.md
│ │ │ │ ├── layout-props.md
│ │ │ │ ├── theme-variable-defaults.md
│ │ │ │ ├── theme-variables.md
│ │ │ │ └── themes.md
│ │ │ ├── template-properties.md
│ │ │ ├── test.md
│ │ │ ├── tutorial-01.md
│ │ │ ├── tutorial-02.md
│ │ │ ├── tutorial-03.md
│ │ │ ├── tutorial-04.md
│ │ │ ├── tutorial-05.md
│ │ │ ├── tutorial-06.md
│ │ │ ├── tutorial-07.md
│ │ │ ├── tutorial-08.md
│ │ │ ├── tutorial-09.md
│ │ │ ├── tutorial-10.md
│ │ │ ├── tutorial-11.md
│ │ │ ├── tutorial-12.md
│ │ │ ├── universal-properties.md
│ │ │ ├── user-defined-components.md
│ │ │ ├── vscode.md
│ │ │ ├── working-with-markdown.md
│ │ │ ├── working-with-text.md
│ │ │ ├── xmlui-animations
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ ├── Animation.md
│ │ │ │ ├── FadeAnimation.md
│ │ │ │ ├── FadeInAnimation.md
│ │ │ │ ├── FadeOutAnimation.md
│ │ │ │ ├── ScaleAnimation.md
│ │ │ │ └── SlideInAnimation.md
│ │ │ ├── xmlui-charts
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ ├── BarChart.md
│ │ │ │ ├── DonutChart.md
│ │ │ │ ├── LabelList.md
│ │ │ │ ├── Legend.md
│ │ │ │ ├── LineChart.md
│ │ │ │ └── PieChart.md
│ │ │ ├── xmlui-pdf
│ │ │ │ ├── _meta.json
│ │ │ │ ├── _overview.md
│ │ │ │ └── Pdf.md
│ │ │ └── xmlui-spreadsheet
│ │ │ ├── _meta.json
│ │ │ ├── _overview.md
│ │ │ └── Spreadsheet.md
│ │ ├── resources
│ │ │ ├── devdocs
│ │ │ │ ├── debug-proxy-object-2.png
│ │ │ │ ├── debug-proxy-object.png
│ │ │ │ ├── table_editor_01.png
│ │ │ │ ├── table_editor_02.png
│ │ │ │ ├── table_editor_03.png
│ │ │ │ ├── table_editor_04.png
│ │ │ │ ├── table_editor_05.png
│ │ │ │ ├── table_editor_06.png
│ │ │ │ ├── table_editor_07.png
│ │ │ │ ├── table_editor_08.png
│ │ │ │ ├── table_editor_09.png
│ │ │ │ ├── table_editor_10.png
│ │ │ │ ├── table_editor_11.png
│ │ │ │ ├── table-editor-01.png
│ │ │ │ ├── table-editor-02.png
│ │ │ │ ├── table-editor-03.png
│ │ │ │ ├── table-editor-04.png
│ │ │ │ ├── table-editor-06.png
│ │ │ │ ├── table-editor-07.png
│ │ │ │ ├── table-editor-08.png
│ │ │ │ ├── table-editor-09.png
│ │ │ │ └── xmlui-rendering-of-tiptap-markdown.png
│ │ │ ├── favicon.ico
│ │ │ ├── files
│ │ │ │ ├── clients.json
│ │ │ │ ├── daily-revenue.json
│ │ │ │ ├── dashboard-stats.json
│ │ │ │ ├── demo.xmlui
│ │ │ │ ├── demo.xmlui.xs
│ │ │ │ ├── downloads
│ │ │ │ │ └── downloads.json
│ │ │ │ ├── for-download
│ │ │ │ │ ├── index-with-api.html
│ │ │ │ │ ├── index.html
│ │ │ │ │ ├── mockApi.js
│ │ │ │ │ ├── start-darwin.sh
│ │ │ │ │ ├── start-linux.sh
│ │ │ │ │ ├── start.bat
│ │ │ │ │ └── xmlui
│ │ │ │ │ └── xmlui-standalone.umd.js
│ │ │ │ ├── getting-started
│ │ │ │ │ ├── cl-tutorial-final.zip
│ │ │ │ │ ├── cl-tutorial.zip
│ │ │ │ │ ├── cl-tutorial2.zip
│ │ │ │ │ ├── cl-tutorial3.zip
│ │ │ │ │ ├── cl-tutorial4.zip
│ │ │ │ │ ├── cl-tutorial5.zip
│ │ │ │ │ ├── cl-tutorial6.zip
│ │ │ │ │ ├── getting-started.zip
│ │ │ │ │ ├── hello-xmlui.zip
│ │ │ │ │ ├── xmlui-empty.zip
│ │ │ │ │ └── xmlui-starter.zip
│ │ │ │ ├── howto
│ │ │ │ │ └── component-icons
│ │ │ │ │ └── up-arrow.svg
│ │ │ │ ├── invoices.json
│ │ │ │ ├── monthly-status.json
│ │ │ │ ├── news-and-reviews.json
│ │ │ │ ├── products.json
│ │ │ │ ├── releases.json
│ │ │ │ ├── tutorials
│ │ │ │ │ ├── datasource
│ │ │ │ │ │ └── api.ts
│ │ │ │ │ └── p2do
│ │ │ │ │ ├── api.ts
│ │ │ │ │ └── todo-logo.svg
│ │ │ │ └── xmlui.json
│ │ │ ├── github.svg
│ │ │ ├── images
│ │ │ │ ├── apiaction-tutorial
│ │ │ │ │ ├── add-success.png
│ │ │ │ │ ├── apiaction-param.png
│ │ │ │ │ ├── change-completed.png
│ │ │ │ │ ├── change-in-progress.png
│ │ │ │ │ ├── confirm-delete.png
│ │ │ │ │ ├── data-error.png
│ │ │ │ │ ├── data-progress.png
│ │ │ │ │ ├── data-success.png
│ │ │ │ │ ├── display-1.png
│ │ │ │ │ ├── item-deleted.png
│ │ │ │ │ ├── item-updated.png
│ │ │ │ │ ├── missing-api-key.png
│ │ │ │ │ ├── new-item-added.png
│ │ │ │ │ └── test-message.png
│ │ │ │ ├── chat-api
│ │ │ │ │ └── domain-model.svg
│ │ │ │ ├── components
│ │ │ │ │ ├── image
│ │ │ │ │ │ └── breakfast.jpg
│ │ │ │ │ ├── markdown
│ │ │ │ │ │ └── colors.png
│ │ │ │ │ └── modal
│ │ │ │ │ ├── deep_link_dialog_1.jpg
│ │ │ │ │ └── deep_link_dialog_2.jpg
│ │ │ │ ├── create-apps
│ │ │ │ │ ├── collapsed-vertical.png
│ │ │ │ │ ├── using-forms-warning-dialog.png
│ │ │ │ │ └── using-forms.png
│ │ │ │ ├── datasource-tutorial
│ │ │ │ │ ├── data-with-header.png
│ │ │ │ │ ├── filtered-data.png
│ │ │ │ │ ├── filtered-items.png
│ │ │ │ │ ├── initial-page-items.png
│ │ │ │ │ ├── list-items.png
│ │ │ │ │ ├── next-page-items.png
│ │ │ │ │ ├── no-data.png
│ │ │ │ │ ├── pagination-1.jpg
│ │ │ │ │ ├── pagination-1.png
│ │ │ │ │ ├── polling-1.png
│ │ │ │ │ ├── refetch-data.png
│ │ │ │ │ ├── slow-loading.png
│ │ │ │ │ ├── test-message.png
│ │ │ │ │ ├── Thumbs.db
│ │ │ │ │ ├── unconventional-data.png
│ │ │ │ │ └── unfiltered-items.png
│ │ │ │ ├── flower.jpg
│ │ │ │ ├── get-started
│ │ │ │ │ ├── add-new-contact.png
│ │ │ │ │ ├── app-modified.png
│ │ │ │ │ ├── app-start.png
│ │ │ │ │ ├── app-with-boxes.png
│ │ │ │ │ ├── app-with-toast.png
│ │ │ │ │ ├── boilerplate-structure.png
│ │ │ │ │ ├── cl-initial.png
│ │ │ │ │ ├── cl-start.png
│ │ │ │ │ ├── contact-counts.png
│ │ │ │ │ ├── contact-dialog-title.png
│ │ │ │ │ ├── contact-dialog.png
│ │ │ │ │ ├── contact-menus.png
│ │ │ │ │ ├── contact-predicates.png
│ │ │ │ │ ├── context-menu.png
│ │ │ │ │ ├── dashboard-numbers.png
│ │ │ │ │ ├── default-contact-list.png
│ │ │ │ │ ├── delete-contact.png
│ │ │ │ │ ├── delete-task.png
│ │ │ │ │ ├── detailed-template.png
│ │ │ │ │ ├── edit-contact-details.png
│ │ │ │ │ ├── edited-contact-saved.png
│ │ │ │ │ ├── empty-sections.png
│ │ │ │ │ ├── filter-completed.png
│ │ │ │ │ ├── fullwidth-desktop.png
│ │ │ │ │ ├── fullwidth-mobile.png
│ │ │ │ │ ├── initial-table.png
│ │ │ │ │ ├── items-and-badges.png
│ │ │ │ │ ├── loading-message.png
│ │ │ │ │ ├── new-contact-button.png
│ │ │ │ │ ├── new-contact-saved.png
│ │ │ │ │ ├── no-empty-sections.png
│ │ │ │ │ ├── personal-todo-initial.png
│ │ │ │ │ ├── piechart.png
│ │ │ │ │ ├── review-today.png
│ │ │ │ │ ├── rudimentary-dashboard.png
│ │ │ │ │ ├── section-collapsed.png
│ │ │ │ │ ├── sectioned-items.png
│ │ │ │ │ ├── sections-ordered.png
│ │ │ │ │ ├── spacex-list-with-links.png
│ │ │ │ │ ├── spacex-list.png
│ │ │ │ │ ├── start-personal-todo-1.png
│ │ │ │ │ ├── submit-new-contact.png
│ │ │ │ │ ├── submit-new-task.png
│ │ │ │ │ ├── syntax-highlighting.png
│ │ │ │ │ ├── table-with-badge.png
│ │ │ │ │ ├── template-with-card.png
│ │ │ │ │ ├── test-emulated-api.png
│ │ │ │ │ ├── Thumbs.db
│ │ │ │ │ ├── todo-logo.png
│ │ │ │ │ └── xmlui-tools.png
│ │ │ │ ├── HelloApp.png
│ │ │ │ ├── HelloApp2.png
│ │ │ │ ├── logos
│ │ │ │ │ ├── xmlui1.svg
│ │ │ │ │ ├── xmlui2.svg
│ │ │ │ │ ├── xmlui3.svg
│ │ │ │ │ ├── xmlui4.svg
│ │ │ │ │ ├── xmlui5.svg
│ │ │ │ │ ├── xmlui6.svg
│ │ │ │ │ └── xmlui7.svg
│ │ │ │ ├── pdf
│ │ │ │ │ └── dummy-pdf.jpg
│ │ │ │ ├── rendering-engine
│ │ │ │ │ ├── AppEngine-flow.svg
│ │ │ │ │ ├── Component.svg
│ │ │ │ │ ├── CompoundComponent.svg
│ │ │ │ │ ├── RootComponent.svg
│ │ │ │ │ └── tree-with-containers.svg
│ │ │ │ ├── reviewers-guide
│ │ │ │ │ ├── AppEngine-flow.svg
│ │ │ │ │ └── incbutton-in-action.png
│ │ │ │ ├── tools
│ │ │ │ │ └── boilerplate-structure.png
│ │ │ │ ├── try.svg
│ │ │ │ ├── tutorial
│ │ │ │ │ ├── app-chat-history.png
│ │ │ │ │ ├── app-content-placeholder.png
│ │ │ │ │ ├── app-header-and-content.png
│ │ │ │ │ ├── app-links-channel-selected.png
│ │ │ │ │ ├── app-links-click.png
│ │ │ │ │ ├── app-navigation.png
│ │ │ │ │ ├── finished-ex01.png
│ │ │ │ │ ├── finished-ex02.png
│ │ │ │ │ ├── hello.png
│ │ │ │ │ ├── splash-screen-advanced.png
│ │ │ │ │ ├── splash-screen-after-click.png
│ │ │ │ │ ├── splash-screen-centered.png
│ │ │ │ │ ├── splash-screen-events.png
│ │ │ │ │ ├── splash-screen-expression.png
│ │ │ │ │ ├── splash-screen-reuse-after.png
│ │ │ │ │ ├── splash-screen-reuse-before.png
│ │ │ │ │ └── splash-screen.png
│ │ │ │ └── tutorial-01.png
│ │ │ ├── llms.txt
│ │ │ ├── logo-dark.svg
│ │ │ ├── logo.svg
│ │ │ ├── pg-popout.svg
│ │ │ └── xmlui-logo.svg
│ │ ├── serve.json
│ │ └── web.config
│ ├── scripts
│ │ ├── download-latest-xmlui.js
│ │ ├── generate-rss.js
│ │ ├── get-releases.js
│ │ └── utils.js
│ ├── src
│ │ ├── components
│ │ │ ├── BlogOverview.xmlui
│ │ │ ├── BlogPage.xmlui
│ │ │ ├── Boxes.xmlui
│ │ │ ├── Breadcrumb.xmlui
│ │ │ ├── ChangeLog.xmlui
│ │ │ ├── ColorPalette.xmlui
│ │ │ ├── DocumentLinks.xmlui
│ │ │ ├── DocumentPage.xmlui
│ │ │ ├── DocumentPageNoTOC.xmlui
│ │ │ ├── Icons.xmlui
│ │ │ ├── IncButton.xmlui
│ │ │ ├── IncButton2.xmlui
│ │ │ ├── NameValue.xmlui
│ │ │ ├── PageNotFound.xmlui
│ │ │ ├── PaletteItem.xmlui
│ │ │ ├── Palettes.xmlui
│ │ │ ├── SectionHeader.xmlui
│ │ │ ├── TBD.xmlui
│ │ │ ├── Test.xmlui
│ │ │ ├── ThemesIntro.xmlui
│ │ │ ├── ThousandThemes.xmlui
│ │ │ ├── TubeStops.xmlui
│ │ │ ├── TubeStops.xmlui.xs
│ │ │ └── TwoColumnCode.xmlui
│ │ ├── config.ts
│ │ ├── Main.xmlui
│ │ └── themes
│ │ ├── docs-theme.ts
│ │ ├── earthtone.ts
│ │ ├── xmlui-gray-on-default.ts
│ │ ├── xmlui-green-on-default.ts
│ │ └── xmlui-orange-on-default.ts
│ └── tsconfig.json
├── LICENSE
├── package-lock.json
├── package.json
├── packages
│ ├── xmlui-animations
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── Animation.tsx
│ │ │ ├── AnimationNative.tsx
│ │ │ ├── FadeAnimation.tsx
│ │ │ ├── FadeInAnimation.tsx
│ │ │ ├── FadeOutAnimation.tsx
│ │ │ ├── index.tsx
│ │ │ ├── ScaleAnimation.tsx
│ │ │ └── SlideInAnimation.tsx
│ │ └── tsconfig.json
│ ├── xmlui-devtools
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── devtools
│ │ │ │ ├── DevTools.tsx
│ │ │ │ ├── DevToolsNative.module.scss
│ │ │ │ ├── DevToolsNative.tsx
│ │ │ │ ├── ModalDialog.module.scss
│ │ │ │ ├── ModalDialog.tsx
│ │ │ │ ├── ModalVisibilityContext.tsx
│ │ │ │ ├── Tooltip.module.scss
│ │ │ │ ├── Tooltip.tsx
│ │ │ │ └── utils.ts
│ │ │ ├── editor
│ │ │ │ └── Editor.tsx
│ │ │ └── index.tsx
│ │ ├── tsconfig.json
│ │ └── vite.config-overrides.ts
│ ├── xmlui-hello-world
│ │ ├── .gitignore
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── HelloWorld.module.scss
│ │ │ ├── HelloWorld.tsx
│ │ │ ├── HelloWorldNative.tsx
│ │ │ └── index.tsx
│ │ └── tsconfig.json
│ ├── xmlui-os-frames
│ │ ├── .gitignore
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── index.tsx
│ │ │ ├── IPhoneFrame.module.scss
│ │ │ ├── IPhoneFrame.tsx
│ │ │ ├── MacOSAppFrame.module.scss
│ │ │ ├── MacOSAppFrame.tsx
│ │ │ ├── WindowsAppFrame.module.scss
│ │ │ └── WindowsAppFrame.tsx
│ │ └── tsconfig.json
│ ├── xmlui-pdf
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── demo
│ │ │ ├── components
│ │ │ │ └── Pdf.xmlui
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── index.tsx
│ │ │ ├── LazyPdfNative.tsx
│ │ │ ├── Pdf.module.scss
│ │ │ └── Pdf.tsx
│ │ └── tsconfig.json
│ ├── xmlui-playground
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── hooks
│ │ │ │ ├── usePlayground.ts
│ │ │ │ └── useToast.ts
│ │ │ ├── index.tsx
│ │ │ ├── playground
│ │ │ │ ├── Box.module.scss
│ │ │ │ ├── Box.tsx
│ │ │ │ ├── CodeSelector.tsx
│ │ │ │ ├── ConfirmationDialog.module.scss
│ │ │ │ ├── ConfirmationDialog.tsx
│ │ │ │ ├── Editor.tsx
│ │ │ │ ├── Header.module.scss
│ │ │ │ ├── Header.tsx
│ │ │ │ ├── Playground.tsx
│ │ │ │ ├── PlaygroundContent.module.scss
│ │ │ │ ├── PlaygroundContent.tsx
│ │ │ │ ├── PlaygroundNative.module.scss
│ │ │ │ ├── PlaygroundNative.tsx
│ │ │ │ ├── Preview.module.scss
│ │ │ │ ├── Preview.tsx
│ │ │ │ ├── Select.module.scss
│ │ │ │ ├── StandalonePlayground.tsx
│ │ │ │ ├── StandalonePlaygroundNative.module.scss
│ │ │ │ ├── StandalonePlaygroundNative.tsx
│ │ │ │ ├── ThemeSwitcher.module.scss
│ │ │ │ ├── ThemeSwitcher.tsx
│ │ │ │ ├── ToneSwitcher.tsx
│ │ │ │ ├── Tooltip.module.scss
│ │ │ │ ├── Tooltip.tsx
│ │ │ │ └── utils.ts
│ │ │ ├── providers
│ │ │ │ ├── Toast.module.scss
│ │ │ │ └── ToastProvider.tsx
│ │ │ ├── state
│ │ │ │ └── store.ts
│ │ │ ├── themes
│ │ │ │ └── theme.ts
│ │ │ └── utils
│ │ │ └── helpers.ts
│ │ └── tsconfig.json
│ ├── xmlui-search
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── index.tsx
│ │ │ ├── Search.module.scss
│ │ │ └── Search.tsx
│ │ └── tsconfig.json
│ ├── xmlui-spreadsheet
│ │ ├── .gitignore
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ ├── src
│ │ │ ├── index.tsx
│ │ │ ├── Spreadsheet.tsx
│ │ │ └── SpreadsheetNative.tsx
│ │ └── tsconfig.json
│ └── xmlui-website-blocks
│ ├── .gitignore
│ ├── CHANGELOG.md
│ ├── demo
│ │ ├── components
│ │ │ ├── HeroBackgroundBreakoutPage.xmlui
│ │ │ ├── HeroBackgroundsPage.xmlui
│ │ │ ├── HeroContentsPage.xmlui
│ │ │ ├── HeroTextAlignPage.xmlui
│ │ │ ├── HeroTextPage.xmlui
│ │ │ └── HeroTonesPage.xmlui
│ │ ├── Main.xmlui
│ │ └── themes
│ │ └── default.ts
│ ├── index.html
│ ├── index.ts
│ ├── meta
│ │ └── componentsMetadata.ts
│ ├── package.json
│ ├── public
│ │ └── resources
│ │ ├── building.jpg
│ │ └── xmlui-logo.svg
│ ├── src
│ │ ├── Carousel
│ │ │ ├── Carousel.module.scss
│ │ │ ├── Carousel.tsx
│ │ │ ├── CarouselContext.tsx
│ │ │ └── CarouselNative.tsx
│ │ ├── FancyButton
│ │ │ ├── FancyButton.module.scss
│ │ │ ├── FancyButton.tsx
│ │ │ └── FancyButton.xmlui
│ │ ├── Hello
│ │ │ ├── Hello.tsx
│ │ │ ├── Hello.xmlui
│ │ │ └── Hello.xmlui.xs
│ │ ├── HeroSection
│ │ │ ├── HeroSection.module.scss
│ │ │ ├── HeroSection.tsx
│ │ │ └── HeroSectionNative.tsx
│ │ ├── index.tsx
│ │ ├── ScrollToTop
│ │ │ ├── ScrollToTop.module.scss
│ │ │ ├── ScrollToTop.tsx
│ │ │ └── ScrollToTopNative.tsx
│ │ └── vite-env.d.ts
│ └── tsconfig.json
├── README.md
├── tools
│ ├── codefence
│ │ └── xmlui-code-fence-docs.md
│ ├── create-app
│ │ ├── .gitignore
│ │ ├── CHANGELOG.md
│ │ ├── create-app.ts
│ │ ├── helpers
│ │ │ ├── copy.ts
│ │ │ ├── get-pkg-manager.ts
│ │ │ ├── git.ts
│ │ │ ├── install.ts
│ │ │ ├── is-folder-empty.ts
│ │ │ ├── is-writeable.ts
│ │ │ ├── make-dir.ts
│ │ │ └── validate-pkg.ts
│ │ ├── index.ts
│ │ ├── package.json
│ │ ├── templates
│ │ │ ├── default
│ │ │ │ └── ts
│ │ │ │ ├── gitignore
│ │ │ │ ├── index.html
│ │ │ │ ├── index.ts
│ │ │ │ ├── public
│ │ │ │ │ ├── mockServiceWorker.js
│ │ │ │ │ ├── resources
│ │ │ │ │ │ ├── favicon.ico
│ │ │ │ │ │ └── xmlui-logo.svg
│ │ │ │ │ └── serve.json
│ │ │ │ └── src
│ │ │ │ ├── components
│ │ │ │ │ ├── ApiAware.xmlui
│ │ │ │ │ ├── Home.xmlui
│ │ │ │ │ ├── IncButton.xmlui
│ │ │ │ │ └── PagePanel.xmlui
│ │ │ │ ├── config.ts
│ │ │ │ └── Main.xmlui
│ │ │ ├── index.ts
│ │ │ └── types.ts
│ │ └── tsconfig.json
│ ├── create-xmlui-hello-world
│ │ ├── index.js
│ │ └── package.json
│ └── vscode
│ ├── .gitignore
│ ├── .vscode
│ │ ├── launch.json
│ │ └── tasks.json
│ ├── .vscodeignore
│ ├── build.sh
│ ├── CHANGELOG.md
│ ├── esbuild.js
│ ├── eslint.config.mjs
│ ├── formatter-docs.md
│ ├── generate-test-sample.sh
│ ├── LICENSE.md
│ ├── package-lock.json
│ ├── package.json
│ ├── README.md
│ ├── resources
│ │ ├── xmlui-logo.png
│ │ └── xmlui-markup-syntax-highlighting.png
│ ├── src
│ │ ├── extension.ts
│ │ └── server.ts
│ ├── syntaxes
│ │ └── xmlui.tmLanguage.json
│ ├── test-samples
│ │ └── sample.xmlui
│ ├── tsconfig.json
│ └── tsconfig.tsbuildinfo
├── turbo.json
└── xmlui
├── .gitignore
├── bin
│ ├── bootstrap.js
│ ├── build-lib.ts
│ ├── build.ts
│ ├── index.ts
│ ├── preview.ts
│ ├── start.ts
│ ├── vite-xmlui-plugin.ts
│ └── viteConfig.ts
├── CHANGELOG.md
├── conventions
│ ├── component-qa-checklist.md
│ ├── copilot-conventions.md
│ ├── create-xmlui-components.md
│ ├── mermaid.md
│ ├── testing-conventions.md
│ └── xmlui-in-a-nutshell.md
├── dev-docs
│ ├── accessibility.md
│ ├── build-system.md
│ ├── build-xmlui.md
│ ├── component-behaviors.md
│ ├── components-with-options.md
│ ├── containers.md
│ ├── data-operations.md
│ ├── glossary.md
│ ├── index.md
│ ├── next
│ │ ├── component-dev-guide.md
│ │ ├── configuration-management-enhancement-summary.md
│ │ ├── documentation-scripts-refactoring-complete-summary.md
│ │ ├── documentation-scripts-refactoring-plan.md
│ │ ├── duplicate-pattern-extraction-summary.md
│ │ ├── error-handling-standardization-summary.md
│ │ ├── generating-component-reference.md
│ │ ├── index.md
│ │ ├── logging-consistency-implementation-summary.md
│ │ ├── project-build.md
│ │ ├── project-structure.md
│ │ ├── theme-context.md
│ │ ├── tiptap-design-considerations.md
│ │ ├── working-with-code.md
│ │ ├── xmlui-runtime-architecture
│ │ └── xmlui-wcag-accessibility-report.md
│ ├── react-fundamentals.md
│ ├── release-method.md
│ ├── standalone-app.md
│ ├── ud-components.md
│ └── xmlui-repo.md
├── package.json
├── playwright.config.ts
├── scripts
│ ├── coverage-only.js
│ ├── e2e-test-summary.js
│ ├── generate-docs
│ │ ├── build-downloads-map.mjs
│ │ ├── build-pages-map.mjs
│ │ ├── components-config.json
│ │ ├── configuration-management.mjs
│ │ ├── constants.mjs
│ │ ├── create-theme-files.mjs
│ │ ├── DocsGenerator.mjs
│ │ ├── error-handling.mjs
│ │ ├── extensions-config.json
│ │ ├── folders.mjs
│ │ ├── generate-summary-files.mjs
│ │ ├── get-docs.mjs
│ │ ├── input-handler.mjs
│ │ ├── logger.mjs
│ │ ├── logging-standards.mjs
│ │ ├── MetadataProcessor.mjs
│ │ ├── pattern-utilities.mjs
│ │ └── utils.mjs
│ ├── get-langserver-metadata.mjs
│ ├── inline-links.mjs
│ └── README-e2e-summary.md
├── src
│ ├── abstractions
│ │ ├── _conventions.md
│ │ ├── ActionDefs.ts
│ │ ├── AppContextDefs.ts
│ │ ├── ComponentDefs.ts
│ │ ├── ContainerDefs.ts
│ │ ├── ExtensionDefs.ts
│ │ ├── FunctionDefs.ts
│ │ ├── RendererDefs.ts
│ │ ├── scripting
│ │ │ ├── BlockScope.ts
│ │ │ ├── Compilation.ts
│ │ │ ├── LogicalThread.ts
│ │ │ ├── LoopScope.ts
│ │ │ ├── modules.ts
│ │ │ ├── ScriptParserError.ts
│ │ │ ├── Token.ts
│ │ │ ├── TryScope.ts
│ │ │ └── TryScopeExp.ts
│ │ └── ThemingDefs.ts
│ ├── components
│ │ ├── _conventions.md
│ │ ├── abstractions.ts
│ │ ├── Accordion
│ │ │ ├── Accordion.md
│ │ │ ├── Accordion.module.scss
│ │ │ ├── Accordion.spec.ts
│ │ │ ├── Accordion.tsx
│ │ │ ├── AccordionContext.tsx
│ │ │ ├── AccordionItem.tsx
│ │ │ ├── AccordionItemNative.tsx
│ │ │ └── AccordionNative.tsx
│ │ ├── Animation
│ │ │ └── AnimationNative.tsx
│ │ ├── APICall
│ │ │ ├── APICall.md
│ │ │ ├── APICall.spec.ts
│ │ │ ├── APICall.tsx
│ │ │ └── APICallNative.tsx
│ │ ├── App
│ │ │ ├── App.md
│ │ │ ├── App.module.scss
│ │ │ ├── App.spec.ts
│ │ │ ├── App.tsx
│ │ │ ├── AppLayoutContext.ts
│ │ │ ├── AppNative.tsx
│ │ │ ├── AppStateContext.ts
│ │ │ ├── doc-resources
│ │ │ │ ├── condensed-sticky.xmlui
│ │ │ │ ├── condensed.xmlui
│ │ │ │ ├── horizontal-sticky.xmlui
│ │ │ │ ├── horizontal.xmlui
│ │ │ │ ├── vertical-full-header.xmlui
│ │ │ │ ├── vertical-sticky.xmlui
│ │ │ │ └── vertical.xmlui
│ │ │ ├── IndexerContext.ts
│ │ │ ├── LinkInfoContext.ts
│ │ │ ├── SearchContext.tsx
│ │ │ ├── Sheet.module.scss
│ │ │ └── Sheet.tsx
│ │ ├── AppHeader
│ │ │ ├── AppHeader.md
│ │ │ ├── AppHeader.module.scss
│ │ │ ├── AppHeader.spec.ts
│ │ │ ├── AppHeader.tsx
│ │ │ └── AppHeaderNative.tsx
│ │ ├── AppState
│ │ │ ├── AppState.md
│ │ │ ├── AppState.spec.ts
│ │ │ ├── AppState.tsx
│ │ │ └── AppStateNative.tsx
│ │ ├── AutoComplete
│ │ │ ├── AutoComplete.md
│ │ │ ├── AutoComplete.module.scss
│ │ │ ├── AutoComplete.spec.ts
│ │ │ ├── AutoComplete.tsx
│ │ │ ├── AutoCompleteContext.tsx
│ │ │ └── AutoCompleteNative.tsx
│ │ ├── Avatar
│ │ │ ├── Avatar.md
│ │ │ ├── Avatar.module.scss
│ │ │ ├── Avatar.spec.ts
│ │ │ ├── Avatar.tsx
│ │ │ └── AvatarNative.tsx
│ │ ├── Backdrop
│ │ │ ├── Backdrop.md
│ │ │ ├── Backdrop.module.scss
│ │ │ ├── Backdrop.spec.ts
│ │ │ ├── Backdrop.tsx
│ │ │ └── BackdropNative.tsx
│ │ ├── Badge
│ │ │ ├── Badge.md
│ │ │ ├── Badge.module.scss
│ │ │ ├── Badge.spec.ts
│ │ │ ├── Badge.tsx
│ │ │ └── BadgeNative.tsx
│ │ ├── Bookmark
│ │ │ ├── Bookmark.md
│ │ │ ├── Bookmark.module.scss
│ │ │ ├── Bookmark.spec.ts
│ │ │ ├── Bookmark.tsx
│ │ │ └── BookmarkNative.tsx
│ │ ├── Breakout
│ │ │ ├── Breakout.module.scss
│ │ │ ├── Breakout.spec.ts
│ │ │ ├── Breakout.tsx
│ │ │ └── BreakoutNative.tsx
│ │ ├── Button
│ │ │ ├── Button-style.spec.ts
│ │ │ ├── Button.md
│ │ │ ├── Button.module.scss
│ │ │ ├── Button.spec.ts
│ │ │ ├── Button.tsx
│ │ │ └── ButtonNative.tsx
│ │ ├── Card
│ │ │ ├── Card.md
│ │ │ ├── Card.module.scss
│ │ │ ├── Card.spec.ts
│ │ │ ├── Card.tsx
│ │ │ └── CardNative.tsx
│ │ ├── Carousel
│ │ │ ├── Carousel.md
│ │ │ ├── Carousel.module.scss
│ │ │ ├── Carousel.spec.ts
│ │ │ ├── Carousel.tsx
│ │ │ ├── CarouselContext.tsx
│ │ │ ├── CarouselItem.tsx
│ │ │ ├── CarouselItemNative.tsx
│ │ │ └── CarouselNative.tsx
│ │ ├── ChangeListener
│ │ │ ├── ChangeListener.md
│ │ │ ├── ChangeListener.spec.ts
│ │ │ ├── ChangeListener.tsx
│ │ │ └── ChangeListenerNative.tsx
│ │ ├── chart-color-schemes.ts
│ │ ├── Charts
│ │ │ ├── AreaChart
│ │ │ │ ├── AreaChart.md
│ │ │ │ ├── AreaChart.spec.ts
│ │ │ │ ├── AreaChart.tsx
│ │ │ │ └── AreaChartNative.tsx
│ │ │ ├── BarChart
│ │ │ │ ├── BarChart.md
│ │ │ │ ├── BarChart.module.scss
│ │ │ │ ├── BarChart.spec.ts
│ │ │ │ ├── BarChart.tsx
│ │ │ │ └── BarChartNative.tsx
│ │ │ ├── DonutChart
│ │ │ │ ├── DonutChart.spec.ts
│ │ │ │ └── DonutChart.tsx
│ │ │ ├── LabelList
│ │ │ │ ├── LabelList.spec.ts
│ │ │ │ ├── LabelList.tsx
│ │ │ │ ├── LabelListNative.module.scss
│ │ │ │ └── LabelListNative.tsx
│ │ │ ├── Legend
│ │ │ │ ├── Legend.spec.ts
│ │ │ │ ├── Legend.tsx
│ │ │ │ └── LegendNative.tsx
│ │ │ ├── LineChart
│ │ │ │ ├── LineChart.md
│ │ │ │ ├── LineChart.module.scss
│ │ │ │ ├── LineChart.spec.ts
│ │ │ │ ├── LineChart.tsx
│ │ │ │ └── LineChartNative.tsx
│ │ │ ├── PieChart
│ │ │ │ ├── PieChart.md
│ │ │ │ ├── PieChart.spec.ts
│ │ │ │ ├── PieChart.tsx
│ │ │ │ ├── PieChartNative.module.scss
│ │ │ │ └── PieChartNative.tsx
│ │ │ ├── RadarChart
│ │ │ │ ├── RadarChart.md
│ │ │ │ ├── RadarChart.spec.ts
│ │ │ │ ├── RadarChart.tsx
│ │ │ │ └── RadarChartNative.tsx
│ │ │ ├── Tooltip
│ │ │ │ ├── TooltipContent.module.scss
│ │ │ │ ├── TooltipContent.spec.ts
│ │ │ │ └── TooltipContent.tsx
│ │ │ └── utils
│ │ │ ├── abstractions.ts
│ │ │ └── ChartProvider.tsx
│ │ ├── Checkbox
│ │ │ ├── Checkbox.md
│ │ │ ├── Checkbox.spec.ts
│ │ │ └── Checkbox.tsx
│ │ ├── CodeBlock
│ │ │ ├── CodeBlock.module.scss
│ │ │ ├── CodeBlock.spec.ts
│ │ │ ├── CodeBlock.tsx
│ │ │ ├── CodeBlockNative.tsx
│ │ │ └── highlight-code.ts
│ │ ├── collectedComponentMetadata.ts
│ │ ├── ColorPicker
│ │ │ ├── ColorPicker.md
│ │ │ ├── ColorPicker.module.scss
│ │ │ ├── ColorPicker.spec.ts
│ │ │ ├── ColorPicker.tsx
│ │ │ └── ColorPickerNative.tsx
│ │ ├── Column
│ │ │ ├── Column.md
│ │ │ ├── Column.tsx
│ │ │ ├── ColumnNative.tsx
│ │ │ ├── doc-resources
│ │ │ │ └── list-component-data.js
│ │ │ └── TableContext.tsx
│ │ ├── component-utils.ts
│ │ ├── ComponentProvider.tsx
│ │ ├── ComponentRegistryContext.tsx
│ │ ├── container-helpers.tsx
│ │ ├── ContentSeparator
│ │ │ ├── ContentSeparator.md
│ │ │ ├── ContentSeparator.module.scss
│ │ │ ├── ContentSeparator.spec.ts
│ │ │ ├── ContentSeparator.tsx
│ │ │ └── ContentSeparatorNative.tsx
│ │ ├── DataSource
│ │ │ ├── DataSource.md
│ │ │ └── DataSource.tsx
│ │ ├── DateInput
│ │ │ ├── DateInput.md
│ │ │ ├── DateInput.module.scss
│ │ │ ├── DateInput.spec.ts
│ │ │ ├── DateInput.tsx
│ │ │ └── DateInputNative.tsx
│ │ ├── DatePicker
│ │ │ ├── DatePicker.md
│ │ │ ├── DatePicker.module.scss
│ │ │ ├── DatePicker.spec.ts
│ │ │ ├── DatePicker.tsx
│ │ │ └── DatePickerNative.tsx
│ │ ├── DropdownMenu
│ │ │ ├── DropdownMenu.md
│ │ │ ├── DropdownMenu.module.scss
│ │ │ ├── DropdownMenu.spec.ts
│ │ │ ├── DropdownMenu.tsx
│ │ │ ├── DropdownMenuNative.tsx
│ │ │ ├── MenuItem.md
│ │ │ └── SubMenuItem.md
│ │ ├── EmojiSelector
│ │ │ ├── EmojiSelector.md
│ │ │ ├── EmojiSelector.spec.ts
│ │ │ ├── EmojiSelector.tsx
│ │ │ └── EmojiSelectorNative.tsx
│ │ ├── ExpandableItem
│ │ │ ├── ExpandableItem.module.scss
│ │ │ ├── ExpandableItem.spec.ts
│ │ │ ├── ExpandableItem.tsx
│ │ │ └── ExpandableItemNative.tsx
│ │ ├── FileInput
│ │ │ ├── FileInput.md
│ │ │ ├── FileInput.module.scss
│ │ │ ├── FileInput.spec.ts
│ │ │ ├── FileInput.tsx
│ │ │ └── FileInputNative.tsx
│ │ ├── FileUploadDropZone
│ │ │ ├── FileUploadDropZone.md
│ │ │ ├── FileUploadDropZone.module.scss
│ │ │ ├── FileUploadDropZone.spec.ts
│ │ │ ├── FileUploadDropZone.tsx
│ │ │ └── FileUploadDropZoneNative.tsx
│ │ ├── FlowLayout
│ │ │ ├── FlowLayout.md
│ │ │ ├── FlowLayout.module.scss
│ │ │ ├── FlowLayout.spec.ts
│ │ │ ├── FlowLayout.spec.ts-snapshots
│ │ │ │ └── Edge-cases-boxShadow-is-not-clipped-1-non-smoke-darwin.png
│ │ │ ├── FlowLayout.tsx
│ │ │ └── FlowLayoutNative.tsx
│ │ ├── Footer
│ │ │ ├── Footer.md
│ │ │ ├── Footer.module.scss
│ │ │ ├── Footer.spec.ts
│ │ │ ├── Footer.tsx
│ │ │ └── FooterNative.tsx
│ │ ├── Form
│ │ │ ├── Form.md
│ │ │ ├── Form.module.scss
│ │ │ ├── Form.spec.ts
│ │ │ ├── Form.tsx
│ │ │ ├── formActions.ts
│ │ │ ├── FormContext.ts
│ │ │ └── FormNative.tsx
│ │ ├── FormItem
│ │ │ ├── FormItem.md
│ │ │ ├── FormItem.module.scss
│ │ │ ├── FormItem.spec.ts
│ │ │ ├── FormItem.tsx
│ │ │ ├── FormItemNative.tsx
│ │ │ ├── HelperText.module.scss
│ │ │ ├── HelperText.tsx
│ │ │ ├── ItemWithLabel.tsx
│ │ │ └── Validations.ts
│ │ ├── FormSection
│ │ │ ├── FormSection.md
│ │ │ ├── FormSection.ts
│ │ │ └── FormSection.xmlui
│ │ ├── Fragment
│ │ │ ├── Fragment.spec.ts
│ │ │ └── Fragment.tsx
│ │ ├── Heading
│ │ │ ├── abstractions.ts
│ │ │ ├── H1.md
│ │ │ ├── H1.spec.ts
│ │ │ ├── H2.md
│ │ │ ├── H2.spec.ts
│ │ │ ├── H3.md
│ │ │ ├── H3.spec.ts
│ │ │ ├── H4.md
│ │ │ ├── H4.spec.ts
│ │ │ ├── H5.md
│ │ │ ├── H5.spec.ts
│ │ │ ├── H6.md
│ │ │ ├── H6.spec.ts
│ │ │ ├── Heading.md
│ │ │ ├── Heading.module.scss
│ │ │ ├── Heading.spec.ts
│ │ │ ├── Heading.tsx
│ │ │ └── HeadingNative.tsx
│ │ ├── HoverCard
│ │ │ ├── HoverCard.tsx
│ │ │ └── HovercardNative.tsx
│ │ ├── HtmlTags
│ │ │ ├── HtmlTags.module.scss
│ │ │ ├── HtmlTags.spec.ts
│ │ │ └── HtmlTags.tsx
│ │ ├── Icon
│ │ │ ├── AdmonitionDanger.tsx
│ │ │ ├── AdmonitionInfo.tsx
│ │ │ ├── AdmonitionNote.tsx
│ │ │ ├── AdmonitionTip.tsx
│ │ │ ├── AdmonitionWarning.tsx
│ │ │ ├── ApiIcon.tsx
│ │ │ ├── ArrowDropDown.module.scss
│ │ │ ├── ArrowDropDown.tsx
│ │ │ ├── ArrowDropUp.module.scss
│ │ │ ├── ArrowDropUp.tsx
│ │ │ ├── ArrowLeft.module.scss
│ │ │ ├── ArrowLeft.tsx
│ │ │ ├── ArrowRight.module.scss
│ │ │ ├── ArrowRight.tsx
│ │ │ ├── Attach.tsx
│ │ │ ├── Binding.module.scss
│ │ │ ├── Binding.tsx
│ │ │ ├── BoardIcon.tsx
│ │ │ ├── BoxIcon.tsx
│ │ │ ├── CheckIcon.tsx
│ │ │ ├── ChevronDownIcon.tsx
│ │ │ ├── ChevronLeft.tsx
│ │ │ ├── ChevronRight.tsx
│ │ │ ├── ChevronUpIcon.tsx
│ │ │ ├── CodeFileIcon.tsx
│ │ │ ├── CodeSandbox.tsx
│ │ │ ├── CompactListIcon.tsx
│ │ │ ├── ContentCopyIcon.tsx
│ │ │ ├── DarkToLightIcon.tsx
│ │ │ ├── DatabaseIcon.module.scss
│ │ │ ├── DatabaseIcon.tsx
│ │ │ ├── DocFileIcon.tsx
│ │ │ ├── DocIcon.tsx
│ │ │ ├── DotMenuHorizontalIcon.tsx
│ │ │ ├── DotMenuIcon.tsx
│ │ │ ├── EmailIcon.tsx
│ │ │ ├── EmptyFolderIcon.tsx
│ │ │ ├── ErrorIcon.tsx
│ │ │ ├── ExpressionIcon.tsx
│ │ │ ├── FillPlusCricleIcon.tsx
│ │ │ ├── FilterIcon.tsx
│ │ │ ├── FolderIcon.tsx
│ │ │ ├── GlobeIcon.tsx
│ │ │ ├── HomeIcon.tsx
│ │ │ ├── HyperLinkIcon.tsx
│ │ │ ├── Icon.md
│ │ │ ├── Icon.module.scss
│ │ │ ├── Icon.spec.ts
│ │ │ ├── Icon.tsx
│ │ │ ├── IconNative.tsx
│ │ │ ├── ImageFileIcon.tsx
│ │ │ ├── Inspect.tsx
│ │ │ ├── LightToDark.tsx
│ │ │ ├── LinkIcon.tsx
│ │ │ ├── ListIcon.tsx
│ │ │ ├── LooseListIcon.tsx
│ │ │ ├── MoonIcon.tsx
│ │ │ ├── MoreOptionsIcon.tsx
│ │ │ ├── NoSortIcon.tsx
│ │ │ ├── PDFIcon.tsx
│ │ │ ├── PenIcon.tsx
│ │ │ ├── PhoneIcon.tsx
│ │ │ ├── PhotoIcon.tsx
│ │ │ ├── PlusIcon.tsx
│ │ │ ├── SearchIcon.tsx
│ │ │ ├── ShareIcon.tsx
│ │ │ ├── SortAscendingIcon.tsx
│ │ │ ├── SortDescendingIcon.tsx
│ │ │ ├── StarsIcon.tsx
│ │ │ ├── SunIcon.tsx
│ │ │ ├── svg
│ │ │ │ ├── admonition_danger.svg
│ │ │ │ ├── admonition_info.svg
│ │ │ │ ├── admonition_note.svg
│ │ │ │ ├── admonition_tip.svg
│ │ │ │ ├── admonition_warning.svg
│ │ │ │ ├── api.svg
│ │ │ │ ├── arrow-dropdown.svg
│ │ │ │ ├── arrow-left.svg
│ │ │ │ ├── arrow-right.svg
│ │ │ │ ├── arrow-up.svg
│ │ │ │ ├── attach.svg
│ │ │ │ ├── binding.svg
│ │ │ │ ├── box.svg
│ │ │ │ ├── bulb.svg
│ │ │ │ ├── code-file.svg
│ │ │ │ ├── code-sandbox.svg
│ │ │ │ ├── dark_to_light.svg
│ │ │ │ ├── database.svg
│ │ │ │ ├── doc.svg
│ │ │ │ ├── empty-folder.svg
│ │ │ │ ├── expression.svg
│ │ │ │ ├── eye-closed.svg
│ │ │ │ ├── eye-dark.svg
│ │ │ │ ├── eye.svg
│ │ │ │ ├── file-text.svg
│ │ │ │ ├── filter.svg
│ │ │ │ ├── folder.svg
│ │ │ │ ├── img.svg
│ │ │ │ ├── inspect.svg
│ │ │ │ ├── light_to_dark.svg
│ │ │ │ ├── moon.svg
│ │ │ │ ├── pdf.svg
│ │ │ │ ├── photo.svg
│ │ │ │ ├── share.svg
│ │ │ │ ├── stars.svg
│ │ │ │ ├── sun.svg
│ │ │ │ ├── trending-down.svg
│ │ │ │ ├── trending-level.svg
│ │ │ │ ├── trending-up.svg
│ │ │ │ ├── txt.svg
│ │ │ │ ├── unknown-file.svg
│ │ │ │ ├── unlink.svg
│ │ │ │ └── xls.svg
│ │ │ ├── TableDeleteColumnIcon.tsx
│ │ │ ├── TableDeleteRowIcon.tsx
│ │ │ ├── TableInsertColumnIcon.tsx
│ │ │ ├── TableInsertRowIcon.tsx
│ │ │ ├── TrashIcon.tsx
│ │ │ ├── TrendingDownIcon.tsx
│ │ │ ├── TrendingLevelIcon.tsx
│ │ │ ├── TrendingUpIcon.tsx
│ │ │ ├── TxtIcon.tsx
│ │ │ ├── UnknownFileIcon.tsx
│ │ │ ├── UnlinkIcon.tsx
│ │ │ ├── UserIcon.tsx
│ │ │ ├── WarningIcon.tsx
│ │ │ └── XlsIcon.tsx
│ │ ├── IconProvider.tsx
│ │ ├── IconRegistryContext.tsx
│ │ ├── IFrame
│ │ │ ├── IFrame.md
│ │ │ ├── IFrame.module.scss
│ │ │ ├── IFrame.spec.ts
│ │ │ ├── IFrame.tsx
│ │ │ └── IFrameNative.tsx
│ │ ├── Image
│ │ │ ├── Image.md
│ │ │ ├── Image.module.scss
│ │ │ ├── Image.spec.ts
│ │ │ ├── Image.tsx
│ │ │ └── ImageNative.tsx
│ │ ├── Input
│ │ │ ├── index.ts
│ │ │ ├── InputAdornment.module.scss
│ │ │ ├── InputAdornment.tsx
│ │ │ ├── InputDivider.module.scss
│ │ │ ├── InputDivider.tsx
│ │ │ ├── InputLabel.module.scss
│ │ │ ├── InputLabel.tsx
│ │ │ ├── PartialInput.module.scss
│ │ │ └── PartialInput.tsx
│ │ ├── InspectButton
│ │ │ ├── InspectButton.module.scss
│ │ │ └── InspectButton.tsx
│ │ ├── Items
│ │ │ ├── Items.md
│ │ │ ├── Items.spec.ts
│ │ │ ├── Items.tsx
│ │ │ └── ItemsNative.tsx
│ │ ├── Link
│ │ │ ├── Link.md
│ │ │ ├── Link.module.scss
│ │ │ ├── Link.spec.ts
│ │ │ ├── Link.tsx
│ │ │ └── LinkNative.tsx
│ │ ├── List
│ │ │ ├── doc-resources
│ │ │ │ └── list-component-data.js
│ │ │ ├── List.md
│ │ │ ├── List.module.scss
│ │ │ ├── List.spec.ts
│ │ │ ├── List.tsx
│ │ │ └── ListNative.tsx
│ │ ├── Logo
│ │ │ ├── doc-resources
│ │ │ │ └── xmlui-logo.svg
│ │ │ ├── Logo.md
│ │ │ ├── Logo.tsx
│ │ │ └── LogoNative.tsx
│ │ ├── Markdown
│ │ │ ├── CodeText.module.scss
│ │ │ ├── CodeText.tsx
│ │ │ ├── Markdown.md
│ │ │ ├── Markdown.module.scss
│ │ │ ├── Markdown.spec.ts
│ │ │ ├── Markdown.tsx
│ │ │ ├── MarkdownNative.tsx
│ │ │ ├── parse-binding-expr.ts
│ │ │ └── utils.ts
│ │ ├── metadata-helpers.ts
│ │ ├── ModalDialog
│ │ │ ├── ConfirmationModalContextProvider.tsx
│ │ │ ├── Dialog.module.scss
│ │ │ ├── Dialog.tsx
│ │ │ ├── ModalDialog.md
│ │ │ ├── ModalDialog.module.scss
│ │ │ ├── ModalDialog.spec.ts
│ │ │ ├── ModalDialog.tsx
│ │ │ ├── ModalDialogNative.tsx
│ │ │ └── ModalVisibilityContext.tsx
│ │ ├── NavGroup
│ │ │ ├── NavGroup.md
│ │ │ ├── NavGroup.module.scss
│ │ │ ├── NavGroup.spec.ts
│ │ │ ├── NavGroup.tsx
│ │ │ ├── NavGroupContext.ts
│ │ │ └── NavGroupNative.tsx
│ │ ├── NavLink
│ │ │ ├── NavLink.md
│ │ │ ├── NavLink.module.scss
│ │ │ ├── NavLink.spec.ts
│ │ │ ├── NavLink.tsx
│ │ │ └── NavLinkNative.tsx
│ │ ├── NavPanel
│ │ │ ├── NavPanel.md
│ │ │ ├── NavPanel.module.scss
│ │ │ ├── NavPanel.spec.ts
│ │ │ ├── NavPanel.tsx
│ │ │ └── NavPanelNative.tsx
│ │ ├── NestedApp
│ │ │ ├── AppWithCodeView.module.scss
│ │ │ ├── AppWithCodeView.tsx
│ │ │ ├── AppWithCodeViewNative.tsx
│ │ │ ├── defaultProps.tsx
│ │ │ ├── logo.svg
│ │ │ ├── NestedApp.module.scss
│ │ │ ├── NestedApp.tsx
│ │ │ ├── NestedAppNative.tsx
│ │ │ ├── Tooltip.module.scss
│ │ │ ├── Tooltip.tsx
│ │ │ └── utils.ts
│ │ ├── NoResult
│ │ │ ├── NoResult.md
│ │ │ ├── NoResult.module.scss
│ │ │ ├── NoResult.spec.ts
│ │ │ ├── NoResult.tsx
│ │ │ └── NoResultNative.tsx
│ │ ├── NumberBox
│ │ │ ├── numberbox-abstractions.ts
│ │ │ ├── NumberBox.md
│ │ │ ├── NumberBox.module.scss
│ │ │ ├── NumberBox.spec.ts
│ │ │ ├── NumberBox.tsx
│ │ │ └── NumberBoxNative.tsx
│ │ ├── Option
│ │ │ ├── Option.md
│ │ │ ├── Option.spec.ts
│ │ │ ├── Option.tsx
│ │ │ ├── OptionNative.tsx
│ │ │ └── OptionTypeProvider.tsx
│ │ ├── PageMetaTitle
│ │ │ ├── PageMetaTilteNative.tsx
│ │ │ ├── PageMetaTitle.md
│ │ │ ├── PageMetaTitle.spec.ts
│ │ │ └── PageMetaTitle.tsx
│ │ ├── Pages
│ │ │ ├── Page.md
│ │ │ ├── Pages.md
│ │ │ ├── Pages.module.scss
│ │ │ ├── Pages.tsx
│ │ │ └── PagesNative.tsx
│ │ ├── Pagination
│ │ │ ├── Pagination.md
│ │ │ ├── Pagination.module.scss
│ │ │ ├── Pagination.spec.ts
│ │ │ ├── Pagination.tsx
│ │ │ └── PaginationNative.tsx
│ │ ├── PositionedContainer
│ │ │ ├── PositionedContainer.module.scss
│ │ │ ├── PositionedContainer.tsx
│ │ │ └── PositionedContainerNative.tsx
│ │ ├── ProfileMenu
│ │ │ ├── ProfileMenu.module.scss
│ │ │ └── ProfileMenu.tsx
│ │ ├── ProgressBar
│ │ │ ├── ProgressBar.md
│ │ │ ├── ProgressBar.module.scss
│ │ │ ├── ProgressBar.spec.ts
│ │ │ ├── ProgressBar.tsx
│ │ │ └── ProgressBarNative.tsx
│ │ ├── Queue
│ │ │ ├── Queue.md
│ │ │ ├── Queue.spec.ts
│ │ │ ├── Queue.tsx
│ │ │ ├── queueActions.ts
│ │ │ └── QueueNative.tsx
│ │ ├── RadioGroup
│ │ │ ├── RadioGroup.md
│ │ │ ├── RadioGroup.module.scss
│ │ │ ├── RadioGroup.spec.ts
│ │ │ ├── RadioGroup.tsx
│ │ │ ├── RadioGroupNative.tsx
│ │ │ ├── RadioItem.tsx
│ │ │ └── RadioItemNative.tsx
│ │ ├── RealTimeAdapter
│ │ │ ├── RealTimeAdapter.tsx
│ │ │ └── RealTimeAdapterNative.tsx
│ │ ├── Redirect
│ │ │ ├── Redirect.md
│ │ │ ├── Redirect.spec.ts
│ │ │ └── Redirect.tsx
│ │ ├── ResponsiveBar
│ │ │ ├── README.md
│ │ │ ├── ResponsiveBar.md
│ │ │ ├── ResponsiveBar.module.scss
│ │ │ ├── ResponsiveBar.spec.ts
│ │ │ ├── ResponsiveBar.tsx
│ │ │ └── ResponsiveBarNative.tsx
│ │ ├── Select
│ │ │ ├── HiddenOption.tsx
│ │ │ ├── OptionContext.ts
│ │ │ ├── Select.md
│ │ │ ├── Select.module.scss
│ │ │ ├── Select.spec.ts
│ │ │ ├── Select.tsx
│ │ │ ├── SelectContext.tsx
│ │ │ └── SelectNative.tsx
│ │ ├── SelectionStore
│ │ │ ├── SelectionStore.md
│ │ │ ├── SelectionStore.tsx
│ │ │ └── SelectionStoreNative.tsx
│ │ ├── Slider
│ │ │ ├── Slider.md
│ │ │ ├── Slider.module.scss
│ │ │ ├── Slider.spec.ts
│ │ │ ├── Slider.tsx
│ │ │ └── SliderNative.tsx
│ │ ├── Slot
│ │ │ ├── Slot.md
│ │ │ ├── Slot.spec.ts
│ │ │ └── Slot.ts
│ │ ├── SlotItem.tsx
│ │ ├── SpaceFiller
│ │ │ ├── SpaceFiller.md
│ │ │ ├── SpaceFiller.module.scss
│ │ │ ├── SpaceFiller.spec.ts
│ │ │ ├── SpaceFiller.tsx
│ │ │ └── SpaceFillerNative.tsx
│ │ ├── Spinner
│ │ │ ├── Spinner.md
│ │ │ ├── Spinner.module.scss
│ │ │ ├── Spinner.spec.ts
│ │ │ ├── Spinner.tsx
│ │ │ └── SpinnerNative.tsx
│ │ ├── Splitter
│ │ │ ├── HSplitter.md
│ │ │ ├── HSplitter.spec.ts
│ │ │ ├── Splitter.md
│ │ │ ├── Splitter.module.scss
│ │ │ ├── Splitter.spec.ts
│ │ │ ├── Splitter.tsx
│ │ │ ├── SplitterNative.tsx
│ │ │ ├── utils.ts
│ │ │ ├── VSplitter.md
│ │ │ └── VSplitter.spec.ts
│ │ ├── Stack
│ │ │ ├── CHStack.md
│ │ │ ├── CHStack.spec.ts
│ │ │ ├── CVStack.md
│ │ │ ├── CVStack.spec.ts
│ │ │ ├── HStack.md
│ │ │ ├── HStack.spec.ts
│ │ │ ├── Stack.md
│ │ │ ├── Stack.module.scss
│ │ │ ├── Stack.spec.ts
│ │ │ ├── Stack.tsx
│ │ │ ├── StackNative.tsx
│ │ │ ├── VStack.md
│ │ │ └── VStack.spec.ts
│ │ ├── StickyBox
│ │ │ ├── StickyBox.md
│ │ │ ├── StickyBox.module.scss
│ │ │ ├── StickyBox.tsx
│ │ │ └── StickyBoxNative.tsx
│ │ ├── Switch
│ │ │ ├── Switch.md
│ │ │ ├── Switch.spec.ts
│ │ │ └── Switch.tsx
│ │ ├── Table
│ │ │ ├── doc-resources
│ │ │ │ └── list-component-data.js
│ │ │ ├── react-table-config.d.ts
│ │ │ ├── Table.md
│ │ │ ├── Table.module.scss
│ │ │ ├── Table.spec.ts
│ │ │ ├── Table.tsx
│ │ │ ├── TableNative.tsx
│ │ │ └── useRowSelection.tsx
│ │ ├── TableOfContents
│ │ │ ├── TableOfContents.module.scss
│ │ │ ├── TableOfContents.spec.ts
│ │ │ ├── TableOfContents.tsx
│ │ │ └── TableOfContentsNative.tsx
│ │ ├── Tabs
│ │ │ ├── TabContext.tsx
│ │ │ ├── TabItem.md
│ │ │ ├── TabItem.tsx
│ │ │ ├── TabItemNative.tsx
│ │ │ ├── Tabs.md
│ │ │ ├── Tabs.module.scss
│ │ │ ├── Tabs.spec.ts
│ │ │ ├── Tabs.tsx
│ │ │ └── TabsNative.tsx
│ │ ├── Text
│ │ │ ├── Text.md
│ │ │ ├── Text.module.scss
│ │ │ ├── Text.spec.ts
│ │ │ ├── Text.tsx
│ │ │ └── TextNative.tsx
│ │ ├── TextArea
│ │ │ ├── TextArea.md
│ │ │ ├── TextArea.module.scss
│ │ │ ├── TextArea.spec.ts
│ │ │ ├── TextArea.tsx
│ │ │ ├── TextAreaNative.tsx
│ │ │ ├── TextAreaResizable.tsx
│ │ │ └── useComposedRef.ts
│ │ ├── TextBox
│ │ │ ├── TextBox.md
│ │ │ ├── TextBox.module.scss
│ │ │ ├── TextBox.spec.ts
│ │ │ ├── TextBox.tsx
│ │ │ └── TextBoxNative.tsx
│ │ ├── Theme
│ │ │ ├── NotificationToast.tsx
│ │ │ ├── Theme.md
│ │ │ ├── Theme.module.scss
│ │ │ ├── Theme.spec.ts
│ │ │ ├── Theme.tsx
│ │ │ └── ThemeNative.tsx
│ │ ├── TimeInput
│ │ │ ├── TimeInput.md
│ │ │ ├── TimeInput.module.scss
│ │ │ ├── TimeInput.spec.ts
│ │ │ ├── TimeInput.tsx
│ │ │ ├── TimeInputNative.tsx
│ │ │ └── utils.ts
│ │ ├── Timer
│ │ │ ├── Timer.md
│ │ │ ├── Timer.spec.ts
│ │ │ ├── Timer.tsx
│ │ │ └── TimerNative.tsx
│ │ ├── Toggle
│ │ │ ├── Toggle.module.scss
│ │ │ └── Toggle.tsx
│ │ ├── ToneChangerButton
│ │ │ ├── ToneChangerButton.md
│ │ │ ├── ToneChangerButton.spec.ts
│ │ │ └── ToneChangerButton.tsx
│ │ ├── ToneSwitch
│ │ │ ├── ToneSwitch.md
│ │ │ ├── ToneSwitch.module.scss
│ │ │ ├── ToneSwitch.spec.ts
│ │ │ ├── ToneSwitch.tsx
│ │ │ └── ToneSwitchNative.tsx
│ │ ├── Tooltip
│ │ │ ├── Tooltip.md
│ │ │ ├── Tooltip.module.scss
│ │ │ ├── Tooltip.spec.ts
│ │ │ ├── Tooltip.tsx
│ │ │ └── TooltipNative.tsx
│ │ ├── Tree
│ │ │ ├── testData.ts
│ │ │ ├── Tree-dynamic.spec.ts
│ │ │ ├── Tree-icons.spec.ts
│ │ │ ├── Tree.md
│ │ │ ├── Tree.spec.ts
│ │ │ ├── TreeComponent.module.scss
│ │ │ ├── TreeComponent.tsx
│ │ │ └── TreeNative.tsx
│ │ ├── TreeDisplay
│ │ │ ├── TreeDisplay.md
│ │ │ ├── TreeDisplay.module.scss
│ │ │ ├── TreeDisplay.tsx
│ │ │ └── TreeDisplayNative.tsx
│ │ ├── ValidationSummary
│ │ │ ├── ValidationSummary.module.scss
│ │ │ └── ValidationSummary.tsx
│ │ └── VisuallyHidden.tsx
│ ├── components-core
│ │ ├── abstractions
│ │ │ ├── ComponentRenderer.ts
│ │ │ ├── LoaderRenderer.ts
│ │ │ ├── standalone.ts
│ │ │ └── treeAbstractions.ts
│ │ ├── action
│ │ │ ├── actions.ts
│ │ │ ├── APICall.tsx
│ │ │ ├── FileDownloadAction.tsx
│ │ │ ├── FileUploadAction.tsx
│ │ │ ├── NavigateAction.tsx
│ │ │ └── TimedAction.tsx
│ │ ├── ApiBoundComponent.tsx
│ │ ├── appContext
│ │ │ ├── date-functions.ts
│ │ │ ├── math-function.ts
│ │ │ └── misc-utils.ts
│ │ ├── AppContext.tsx
│ │ ├── behaviors
│ │ │ ├── Behavior.tsx
│ │ │ └── CoreBehaviors.tsx
│ │ ├── component-hooks.ts
│ │ ├── ComponentDecorator.tsx
│ │ ├── ComponentViewer.tsx
│ │ ├── CompoundComponent.tsx
│ │ ├── constants.ts
│ │ ├── DebugViewProvider.tsx
│ │ ├── descriptorHelper.ts
│ │ ├── devtools
│ │ │ ├── InspectorDialog.module.scss
│ │ │ ├── InspectorDialog.tsx
│ │ │ └── InspectorDialogVisibilityContext.tsx
│ │ ├── EngineError.ts
│ │ ├── event-handlers.ts
│ │ ├── InspectorButton.module.scss
│ │ ├── InspectorContext.tsx
│ │ ├── interception
│ │ │ ├── abstractions.ts
│ │ │ ├── ApiInterceptor.ts
│ │ │ ├── ApiInterceptorProvider.tsx
│ │ │ ├── apiInterceptorWorker.ts
│ │ │ ├── Backend.ts
│ │ │ ├── Errors.ts
│ │ │ ├── IndexedDb.ts
│ │ │ ├── initMock.ts
│ │ │ ├── InMemoryDb.ts
│ │ │ ├── ReadonlyCollection.ts
│ │ │ └── useApiInterceptorContext.tsx
│ │ ├── loader
│ │ │ ├── ApiLoader.tsx
│ │ │ ├── DataLoader.tsx
│ │ │ ├── ExternalDataLoader.tsx
│ │ │ ├── Loader.tsx
│ │ │ ├── MockLoaderRenderer.tsx
│ │ │ └── PageableLoader.tsx
│ │ ├── LoaderComponent.tsx
│ │ ├── markup-check.ts
│ │ ├── parts.ts
│ │ ├── renderers.ts
│ │ ├── rendering
│ │ │ ├── AppContent.tsx
│ │ │ ├── AppRoot.tsx
│ │ │ ├── AppWrapper.tsx
│ │ │ ├── buildProxy.ts
│ │ │ ├── collectFnVarDeps.ts
│ │ │ ├── ComponentAdapter.tsx
│ │ │ ├── ComponentWrapper.tsx
│ │ │ ├── Container.tsx
│ │ │ ├── containers.ts
│ │ │ ├── ContainerWrapper.tsx
│ │ │ ├── ErrorBoundary.module.scss
│ │ │ ├── ErrorBoundary.tsx
│ │ │ ├── InvalidComponent.module.scss
│ │ │ ├── InvalidComponent.tsx
│ │ │ ├── nodeUtils.ts
│ │ │ ├── reducer.ts
│ │ │ ├── renderChild.tsx
│ │ │ ├── StandaloneComponent.tsx
│ │ │ ├── StateContainer.tsx
│ │ │ ├── UnknownComponent.module.scss
│ │ │ ├── UnknownComponent.tsx
│ │ │ └── valueExtractor.ts
│ │ ├── reportEngineError.ts
│ │ ├── RestApiProxy.ts
│ │ ├── script-runner
│ │ │ ├── asyncProxy.ts
│ │ │ ├── AttributeValueParser.ts
│ │ │ ├── bannedFunctions.ts
│ │ │ ├── BindingTreeEvaluationContext.ts
│ │ │ ├── eval-tree-async.ts
│ │ │ ├── eval-tree-common.ts
│ │ │ ├── eval-tree-sync.ts
│ │ │ ├── ParameterParser.ts
│ │ │ ├── process-statement-async.ts
│ │ │ ├── process-statement-common.ts
│ │ │ ├── process-statement-sync.ts
│ │ │ ├── ScriptingSourceTree.ts
│ │ │ ├── simplify-expression.ts
│ │ │ ├── statement-queue.ts
│ │ │ └── visitors.ts
│ │ ├── StandaloneApp.tsx
│ │ ├── StandaloneExtensionManager.ts
│ │ ├── TableOfContentsContext.tsx
│ │ ├── theming
│ │ │ ├── _themes.scss
│ │ │ ├── component-layout-resolver.ts
│ │ │ ├── extendThemeUtils.ts
│ │ │ ├── hvar.ts
│ │ │ ├── layout-resolver.ts
│ │ │ ├── parse-layout-props.ts
│ │ │ ├── StyleContext.tsx
│ │ │ ├── StyleRegistry.ts
│ │ │ ├── ThemeContext.tsx
│ │ │ ├── ThemeProvider.tsx
│ │ │ ├── themes
│ │ │ │ ├── base-utils.ts
│ │ │ │ ├── palette.ts
│ │ │ │ ├── root.ts
│ │ │ │ ├── solid.ts
│ │ │ │ ├── theme-colors.ts
│ │ │ │ └── xmlui.ts
│ │ │ ├── themeVars.module.scss
│ │ │ ├── themeVars.ts
│ │ │ ├── transformThemeVars.ts
│ │ │ └── utils.ts
│ │ ├── utils
│ │ │ ├── actionUtils.ts
│ │ │ ├── audio-utils.ts
│ │ │ ├── base64-utils.ts
│ │ │ ├── compound-utils.ts
│ │ │ ├── css-utils.ts
│ │ │ ├── DataLoaderQueryKeyGenerator.ts
│ │ │ ├── date-utils.ts
│ │ │ ├── extractParam.ts
│ │ │ ├── hooks.tsx
│ │ │ ├── LruCache.ts
│ │ │ ├── mergeProps.ts
│ │ │ ├── misc.ts
│ │ │ ├── request-params.ts
│ │ │ ├── statementUtils.ts
│ │ │ └── treeUtils.ts
│ │ └── xmlui-parser.ts
│ ├── index-standalone.ts
│ ├── index.scss
│ ├── index.ts
│ ├── language-server
│ │ ├── server-common.ts
│ │ ├── server-web-worker.ts
│ │ ├── server.ts
│ │ ├── services
│ │ │ ├── common
│ │ │ │ ├── docs-generation.ts
│ │ │ │ ├── lsp-utils.ts
│ │ │ │ ├── metadata-utils.ts
│ │ │ │ └── syntax-node-utilities.ts
│ │ │ ├── completion.ts
│ │ │ ├── diagnostic.ts
│ │ │ ├── format.ts
│ │ │ └── hover.ts
│ │ └── xmlui-metadata-generated.mjs
│ ├── logging
│ │ ├── LoggerContext.tsx
│ │ ├── LoggerInitializer.tsx
│ │ ├── LoggerService.ts
│ │ └── xmlui.ts
│ ├── logo.svg
│ ├── parsers
│ │ ├── common
│ │ │ ├── GenericToken.ts
│ │ │ ├── InputStream.ts
│ │ │ └── utils.ts
│ │ ├── scripting
│ │ │ ├── code-behind-collect.ts
│ │ │ ├── Lexer.ts
│ │ │ ├── modules.ts
│ │ │ ├── Parser.ts
│ │ │ ├── ParserError.ts
│ │ │ ├── ScriptingNodeTypes.ts
│ │ │ ├── TokenTrait.ts
│ │ │ ├── TokenType.ts
│ │ │ └── tree-visitor.ts
│ │ ├── style-parser
│ │ │ ├── errors.ts
│ │ │ ├── source-tree.ts
│ │ │ ├── StyleInputStream.ts
│ │ │ ├── StyleLexer.ts
│ │ │ ├── StyleParser.ts
│ │ │ └── tokens.ts
│ │ └── xmlui-parser
│ │ ├── CharacterCodes.ts
│ │ ├── diagnostics.ts
│ │ ├── fileExtensions.ts
│ │ ├── index.ts
│ │ ├── lint.ts
│ │ ├── parser.ts
│ │ ├── ParserError.ts
│ │ ├── scanner.ts
│ │ ├── syntax-kind.ts
│ │ ├── syntax-node.ts
│ │ ├── transform.ts
│ │ ├── utils.ts
│ │ ├── xmlui-serializer.ts
│ │ └── xmlui-tree.ts
│ ├── react-app-env.d.ts
│ ├── syntax
│ │ ├── monaco
│ │ │ ├── grammar.monacoLanguage.ts
│ │ │ ├── index.ts
│ │ │ ├── xmlui-dark.ts
│ │ │ ├── xmlui-light.ts
│ │ │ └── xmluiscript.monacoLanguage.ts
│ │ └── textMate
│ │ ├── index.ts
│ │ ├── xmlui-dark.json
│ │ ├── xmlui-light.json
│ │ ├── xmlui.json
│ │ └── xmlui.tmLanguage.json
│ ├── testing
│ │ ├── assertions.ts
│ │ ├── component-test-helpers.ts
│ │ ├── ComponentDrivers.ts
│ │ ├── drivers
│ │ │ ├── DateInputDriver.ts
│ │ │ ├── ModalDialogDriver.ts
│ │ │ ├── NumberBoxDriver.ts
│ │ │ ├── TextBoxDriver.ts
│ │ │ ├── TimeInputDriver.ts
│ │ │ ├── TimerDriver.ts
│ │ │ └── TreeDriver.ts
│ │ ├── fixtures.ts
│ │ ├── infrastructure
│ │ │ ├── index.html
│ │ │ ├── main.tsx
│ │ │ ├── public
│ │ │ │ ├── mockServiceWorker.js
│ │ │ │ ├── resources
│ │ │ │ │ ├── bell.svg
│ │ │ │ │ ├── box.svg
│ │ │ │ │ ├── doc.svg
│ │ │ │ │ ├── eye.svg
│ │ │ │ │ ├── flower-640x480.jpg
│ │ │ │ │ ├── sun.svg
│ │ │ │ │ ├── test-image-100x100.jpg
│ │ │ │ │ └── txt.svg
│ │ │ │ └── serve.json
│ │ │ └── TestBed.tsx
│ │ └── themed-app-test-helpers.ts
│ └── vite-env.d.ts
├── tests
│ ├── components
│ │ ├── CodeBlock
│ │ │ └── hightlight-code.test.ts
│ │ ├── playground-pattern.test.ts
│ │ └── Tree
│ │ └── Tree-states.test.ts
│ ├── components-core
│ │ ├── abstractions
│ │ │ └── treeAbstractions.test.ts
│ │ ├── container
│ │ │ └── buildProxy.test.ts
│ │ ├── interception
│ │ │ ├── orderBy.test.ts
│ │ │ ├── ReadOnlyCollection.test.ts
│ │ │ └── request-param-converter.test.ts
│ │ ├── scripts-runner
│ │ │ ├── AttributeValueParser.test.ts
│ │ │ ├── eval-tree-arrow-async.test.ts
│ │ │ ├── eval-tree-arrow.test.ts
│ │ │ ├── eval-tree-func-decl-async.test.ts
│ │ │ ├── eval-tree-func-decl.test.ts
│ │ │ ├── eval-tree-pre-post.test.ts
│ │ │ ├── eval-tree-regression.test.ts
│ │ │ ├── eval-tree.test.ts
│ │ │ ├── function-proxy.test.ts
│ │ │ ├── parser-regression.test.ts
│ │ │ ├── process-event.test.ts
│ │ │ ├── process-function.test.ts
│ │ │ ├── process-implicit-context.test.ts
│ │ │ ├── process-statement-asgn.test.ts
│ │ │ ├── process-statement-destruct.test.ts
│ │ │ ├── process-statement-regs.test.ts
│ │ │ ├── process-statement-sync.test.ts
│ │ │ ├── process-statement.test.ts
│ │ │ ├── process-switch-sync.test.ts
│ │ │ ├── process-switch.test.ts
│ │ │ ├── process-try-sync.test.ts
│ │ │ ├── process-try.test.ts
│ │ │ └── test-helpers.ts
│ │ ├── test-metadata-handler.ts
│ │ ├── theming
│ │ │ ├── border-segments.test.ts
│ │ │ ├── component-layout.resolver.test.ts
│ │ │ ├── layout-property-parser.test.ts
│ │ │ ├── layout-resolver.test.ts
│ │ │ ├── layout-resolver2.test.ts
│ │ │ ├── layout-vp-override.test.ts
│ │ │ └── padding-segments.test.ts
│ │ └── utils
│ │ ├── date-utils.test.ts
│ │ ├── format-human-elapsed-time.test.ts
│ │ └── LruCache.test.ts
│ ├── language-server
│ │ ├── completion.test.ts
│ │ ├── format.test.ts
│ │ ├── hover.test.ts
│ │ └── mockData.ts
│ └── parsers
│ ├── common
│ │ └── input-stream.test.ts
│ ├── markdown
│ │ └── parse-binding-expression.test.ts
│ ├── parameter-parser.test.ts
│ ├── paremeter-parser.test.ts
│ ├── scripting
│ │ ├── eval-tree-arrow.test.ts
│ │ ├── eval-tree-pre-post.test.ts
│ │ ├── eval-tree.test.ts
│ │ ├── function-proxy.test.ts
│ │ ├── lexer-literals.test.ts
│ │ ├── lexer-misc.test.ts
│ │ ├── module-parse.test.ts
│ │ ├── parser-arrow.test.ts
│ │ ├── parser-assignments.test.ts
│ │ ├── parser-binary.test.ts
│ │ ├── parser-destructuring.test.ts
│ │ ├── parser-errors.test.ts
│ │ ├── parser-expressions.test.ts
│ │ ├── parser-function.test.ts
│ │ ├── parser-literals.test.ts
│ │ ├── parser-primary.test.ts
│ │ ├── parser-regex.test.ts
│ │ ├── parser-statements.test.ts
│ │ ├── parser-unary.test.ts
│ │ ├── process-event.test.ts
│ │ ├── process-implicit-context.test.ts
│ │ ├── process-statement-asgn.test.ts
│ │ ├── process-statement-destruct.test.ts
│ │ ├── process-statement-regs.test.ts
│ │ ├── process-statement-sync.test.ts
│ │ ├── process-statement.test.ts
│ │ ├── process-switch-sync.test.ts
│ │ ├── process-switch.test.ts
│ │ ├── process-try-sync.test.ts
│ │ ├── process-try.test.ts
│ │ ├── simplify-expression.test.ts
│ │ ├── statement-hooks.test.ts
│ │ └── test-helpers.ts
│ ├── style-parser
│ │ ├── generateHvarChain.test.ts
│ │ ├── parseHVar.test.ts
│ │ ├── parser.test.ts
│ │ └── tokens.test.ts
│ └── xmlui
│ ├── lint.test.ts
│ ├── parser.test.ts
│ ├── scanner.test.ts
│ ├── transform.attr.test.ts
│ ├── transform.circular.test.ts
│ ├── transform.element.test.ts
│ ├── transform.errors.test.ts
│ ├── transform.escape.test.ts
│ ├── transform.regression.test.ts
│ ├── transform.script.test.ts
│ ├── transform.test.ts
│ └── xmlui.ts
├── tests-e2e
│ ├── api-bound-component-regression.spec.ts
│ ├── api-call-as-extracted-component.spec.ts
│ ├── assign-to-object-or-array-regression.spec.ts
│ ├── binding-regression.spec.ts
│ ├── children-as-template-context-vars.spec.ts
│ ├── compound-component.spec.ts
│ ├── context-vars-regression.spec.ts
│ ├── data-bindings.spec.ts
│ ├── datasource-and-api-usage-in-var.spec.ts
│ ├── datasource-direct-binding.spec.ts
│ ├── datasource-onLoaded-regression.spec.ts
│ ├── modify-array-item-regression.spec.ts
│ ├── namespaces.spec.ts
│ ├── push-to-array-regression.spec.ts
│ ├── screen-breakpoints.spec.ts
│ ├── scripting.spec.ts
│ ├── state-scope-in-pages.spec.ts
│ └── state-var-scopes.spec.ts
├── tsconfig.bin.json
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.ts
└── vitest.config.ts
```
# Files
--------------------------------------------------------------------------------
/xmlui/src/components-core/rendering/AppWrapper.tsx:
--------------------------------------------------------------------------------
```typescript
import type { ReactNode } from "react";
import React from "react";
import { BrowserRouter, HashRouter, MemoryRouter } from "react-router-dom";
import { QueryClientProvider } from "@tanstack/react-query";
import { Helmet, HelmetProvider } from "react-helmet-async";
import type { ComponentLike } from "../../abstractions/ComponentDefs";
import type { ContributesDefinition } from "../../components/ComponentProvider";
import { ConfirmationModalContextProvider } from "../../components/ModalDialog/ConfirmationModalContextProvider";
import type { ApiInterceptorDefinition } from "../interception/abstractions";
import { EMPTY_OBJECT } from "../constants";
import { IconProvider } from "../../components/IconProvider";
import ThemeProvider from "../theming/ThemeProvider";
import { InspectorProvider } from "../InspectorContext";
import type { GlobalProps } from "./AppRoot";
import { queryClient } from "./AppRoot";
import { AppContent } from "./AppContent";
import type { ContainerWrapperDef } from "./ContainerWrapper";
import { ErrorBoundary } from "./ErrorBoundary";
import type { ThemeTone } from "../../abstractions/ThemingDefs";
import { LoggerProvider } from "../../logging/LoggerContext";
import { LoggerInitializer } from "../../logging/LoggerInitializer";
import type { ProjectCompilation } from "../../abstractions/scripting/Compilation";
import { ComponentViewer } from "../ComponentViewer";
export type TrackContainerHeight = "auto" | "fixed";
export type AppWrapperProps = {
// --- The root node of the application definition; the internal
// --- representation of the entire app to run
node: ComponentLike;
// --- If set to `true`, the app is displayed in preview mode (uses
// --- different routing and changes some aspects of browser integration).
previewMode?: boolean;
// --- The name used as the base name in the router definition
routerBaseName?: string;
// --- Apps can provide their custom (third-party) components, themes,
// --- resources (and, in the future, other artifacts) used in the
// --- application code and markup. This property contains these artifacts.
contributes?: ContributesDefinition;
// --- Apps can define global configuration values (connection strings,
// --- titles, names, etc.) used within the app through the `appGlobals`
// --- property. This property contains the values to pass to `appGlobals`.
globalProps?: GlobalProps;
// --- Apps may use external resources (images, text files, icons, etc.).
// --- This property contains the dictionary of these resources.
resources?: Record<string, string>;
// --- This property indicates that the xmlui app runs in a standalone app.
// --- Its value can be queried in the app code via the `standalone` global
// --- property.
standalone?: boolean;
// --- This property indicates whether the app should track the height of
// --- the app container. We created this property for the preview component
// --- used in the documentation platform. It has no other use.
trackContainerHeight?: TrackContainerHeight;
// --- This property signs that we use the app in the end-to-end test
// --- environment. Components should use their IDs as test IDs added to the
// --- rendered DOM so that test cases can refer to the particular DOM elements.
decorateComponentsWithTestId?: boolean;
// --- This property signs that app rendering runs in debug mode. Components
// --- may display additional information in the browser's console when this
// --- property is set.
debugEnabled?: boolean;
// --- If the app has an emulated API, this property contains the
// --- corresponding API endpoint descriptions.
apiInterceptor?: ApiInterceptorDefinition;
// --- The ID of the default theme to use when the app starts.
defaultTheme?: string;
// --- The default tone to use when the app starts ("light" or "dark").
defaultTone?: ThemeTone;
// --- The app can map resource names to URIs used to access a particular
// --- resource. This dictionary contains these mappings.
resourceMap?: Record<string, string>;
// --- An app can display the source code for learning (and debugging)
// --- purposes. This property is a dictionary of filename and file content
// --- pairs.
sources?: Record<string, string>;
projectCompilation?: ProjectCompilation;
children?: ReactNode;
onInit?: () => void;
};
/**
* This component wraps the application into other layers of (nested) components
* that provide app functionality and services requiring unique interaction with
* the browser or the React environment.
*/
export const AppWrapper = ({
node,
previewMode = false,
routerBaseName: baseName = "",
contributes = EMPTY_OBJECT,
globalProps,
standalone,
trackContainerHeight,
decorateComponentsWithTestId,
debugEnabled,
defaultTheme,
defaultTone,
resources,
resourceMap,
sources,
children,
projectCompilation,
onInit,
}: AppWrapperProps) => {
if (previewMode) {
// --- Prevent leaking the meta items to the parent document,
// --- if it lives in an iframe (e.g. docs)
HelmetProvider.canUseDOM = false;
}
// --- Set a few default properties
const siteName = globalProps?.name || "XMLUI app";
const useHashBasedRouting = globalProps?.useHashBasedRouting ?? true;
// --- The children of the AppWrapper component are the components that
// --- provide the app functionality and services. These components are
// --- wrapped in other components that provide the necessary environment
// --- for the app to run.
const dynamicChildren = (
<HelmetProvider>
<Helmet defaultTitle={siteName} titleTemplate={`%s | ${siteName}`} />
<LoggerProvider>
<LoggerInitializer />
<IconProvider>
<ThemeProvider
resourceMap={resourceMap}
themes={contributes.themes}
defaultTheme={defaultTheme}
defaultTone={defaultTone}
resources={resources}
>
<InspectorProvider
sources={sources}
projectCompilation={projectCompilation}
mockApi={globalProps?.demoMockApi}
>
<ConfirmationModalContextProvider>
<AppContent
onInit={onInit}
rootContainer={node as ContainerWrapperDef}
routerBaseName={baseName}
globalProps={globalProps}
standalone={standalone}
decorateComponentsWithTestId={decorateComponentsWithTestId}
debugEnabled={debugEnabled}
trackContainerHeight={trackContainerHeight}
>
<ComponentViewer />
{children}
</AppContent>
</ConfirmationModalContextProvider>
</InspectorProvider>
</ThemeProvider>
</IconProvider>
</LoggerProvider>
</HelmetProvider>
);
// --- Select the router type for the app
const Router = previewMode ? MemoryRouter : useHashBasedRouting ? HashRouter : BrowserRouter;
const shouldSkipClientRouter = previewMode
? false
: typeof window === "undefined" || process.env.VITE_REMIX;
return (
<ErrorBoundary node={node} location={"root-outer"}>
<QueryClientProvider client={queryClient}>
{/* No router in the REMIX environment */}
{!!shouldSkipClientRouter && dynamicChildren}
{/* Wrap the app in a router in other cases */}
{!shouldSkipClientRouter && (
<Router basename={Router === HashRouter ? undefined : baseName}>
{dynamicChildren}
</Router>
)}
</QueryClientProvider>
</ErrorBoundary>
);
};
```
--------------------------------------------------------------------------------
/xmlui/src/components/Column/Column.md:
--------------------------------------------------------------------------------
```markdown
%-DESC-START
**Key features:**
- **Data binding**: Use `bindTo` to automatically display object properties
- **Component embedding**: Place any component inside `Column`: `Button`, `Text`, `Icon`, etc.
- **Interactive behavior**: Enable/disable sorting and column resizing
- **Layout control**: Set width using pixels, star sizing (`*`, `2*`), or proportional values
- **Column pinning**: Pin columns to left or right edges for sticky behavior
%-DESC-END
%-PROP-START bindTo
```xmlui copy {3}
<App>
<Table data='{[...]}'>
<Column bindTo="name" />
</Table>
</App>
```
```xmlui-pg name="Example: bindTo"
<App>
<Table data='{
[
{
id: 0,
name: "Apples",
quantity: 5,
unit: "pieces",
category: "fruits",
key: 5,
},
{
id: 1,
name: "Bananas",
quantity: 6,
unit: "pieces",
category: "fruits",
key: 4,
},
{
id: 2,
name: "Carrots",
quantity: 100,
unit: "grams",
category: "vegetables",
key: 3,
},
{
id: 3,
name: "Spinach",
quantity: 1,
unit: "bunch",
category: "vegetables",
key: 2,
},
{
id: 4,
name: "Milk",
quantity: 10,
unit: "liter",
category: "dairy",
key: 1,
},
{
id: 5,
name: "Cheese",
quantity: 200,
unit: "grams",
category: "dairy",
key: 0,
},
]}'>
<Column bindTo="name" />
</Table>
</App>
```
%-PROP-END
%-PROP-START canSort
Click on either the `Name` or the `Quantity` column headers to order the data by that attribute.
```xmlui copy /canSort/
<App>
<Table data='{[...]}'>
<Column canSort="true" bindTo="name" />
<Column canSort="true" bindTo="quantity" />
<Column canSort="false" bindTo="unit" />
</Table>
</App>
```
```xmlui-pg name="Example: canSort"
<App>
<Table data='{
[
{
id: 0,
name: "Apples",
quantity: 5,
unit: "pieces",
category: "fruits",
key: 5,
},
{
id: 1,
name: "Bananas",
quantity: 6,
unit: "pieces",
category: "fruits",
key: 4,
},
{
id: 2,
name: "Carrots",
quantity: 100,
unit: "grams",
category: "vegetables",
key: 3,
},
{
id: 3,
name: "Spinach",
quantity: 1,
unit: "bunch",
category: "vegetables",
key: 2,
},
{
id: 4,
name: "Milk",
quantity: 10,
unit: "liter",
category: "dairy",
key: 1,
},
{
id: 5,
name: "Cheese",
quantity: 200,
unit: "grams",
category: "dairy",
key: 0,
},
]}'>
<Column canSort="true" bindTo="name" />
<Column canSort="true" bindTo="quantity" />
<Column canSort="false" bindTo="unit" />
</Table>
</App>
```
%-PROP-END
%-PROP-START header
```xmlui copy {3-4}
<App>
<Table data='{[...]}'>
<Column header="Food Name" bindTo="name" />
<Column header="Food Quantity" bindTo="quantity" />
<Column bindTo="unit" />
</Table>
</App>
```
```xmlui-pg name="Example: header"
<App>
<Table data='{
[
{
id: 0,
name: "Apples",
quantity: 5,
unit: "pieces",
category: "fruits",
key: 5,
},
{
id: 1,
name: "Bananas",
quantity: 6,
unit: "pieces",
category: "fruits",
key: 4,
},
{
id: 2,
name: "Carrots",
quantity: 100,
unit: "grams",
category: "vegetables",
key: 3,
},
{
id: 3,
name: "Spinach",
quantity: 1,
unit: "bunch",
category: "vegetables",
key: 2,
},
{
id: 4,
name: "Milk",
quantity: 10,
unit: "liter",
category: "dairy",
key: 1,
},
{
id: 5,
name: "Cheese",
quantity: 200,
unit: "grams",
category: "dairy",
key: 0,
},
]}'>
<Column header="Food Name" bindTo="name" />
<Column header="Food Quantity" bindTo="quantity" />
<Column bindTo="unit" />
</Table>
</App>
```
%-PROP-END
%-PROP-START pinTo
>[!WARNING]
> By default, the background color of table rows is transparent. When using the `pinTo` property, you should set the background to an explicit (non-transparent) color; otherwise, the scrolled cells will be visible under the pinned columns.
```xmlui copy /pinTo="left"/ /pinTo="right"/
<App>
<Theme backgroundColor-row-Table="$color-surface-0">
<Table data='{[...]}' height="100%">
<Column bindTo="id" width="50px" pinTo="left" />
<Column bindTo="name" width="500px" />
<Column bindTo="quantity" width="300px" />
<Column bindTo="unit" width="300px"/>
<Column bindTo="category" width="100px" pinTo="right"/>
</Table>
</Theme>
</App>
```
Scroll the table contents horizontally to see how the pinned columns are displayed.
```xmlui-pg name="Example: pinTo"
<App>
<Theme backgroundColor-row-Table="$color-surface-0">
<Table data='{
[
{
id: 0,
name: "Apples",
quantity: 5,
unit: "pieces",
category: "fruits",
key: 5,
},
{
id: 1,
name: "Bananas",
quantity: 6,
unit: "pieces",
category: "fruits",
key: 4,
},
{
id: 2,
name: "Carrots",
quantity: 100,
unit: "grams",
category: "vegetables",
key: 3,
},
{
id: 3,
name: "Spinach",
quantity: 1,
unit: "bunch",
category: "vegetables",
key: 2,
},
{
id: 4,
name: "Milk",
quantity: 10,
unit: "liter",
category: "dairy",
key: 1,
},
{
id: 5,
name: "Cheese",
quantity: 200,
unit: "grams",
category: "dairy",
key: 0,
},
]}'
height="100%">
<Column bindTo="id" width="50px" pinTo="left" />
<Column bindTo="name" width="500px" />
<Column bindTo="quantity" width="300px" />
<Column bindTo="unit" width="300px"/>
<Column bindTo="category" width="100px" pinTo="right"/>
</Table>
</Theme>
</App>
```
%-PROP-END
%-PROP-START width
The following example sets the second column to an absolute size (size pixels), while the first and third columns have star sizes:
```xmlui copy {4}
<App>
<Table data='{[...]}'>
<Column bindTo="name" canResize="true" width="3*" />
<Column bindTo="quantity" width="100px" minWidth="50px" maxWidth="500px" />
<Column bindTo="unit" width="*" />
</Table>
</App>
```
Check what happens when you resize table columns:
```xmlui-pg name="Example: width"
<App>
<Table data='{
[
{
id: 0,
name: "Apples",
quantity: 5,
unit: "pieces",
category: "fruits",
key: 5,
},
{
id: 1,
name: "Bananas",
quantity: 6,
unit: "pieces",
category: "fruits",
key: 4,
},
{
id: 2,
name: "Carrots",
quantity: 100,
unit: "grams",
category: "vegetables",
key: 3,
},
{
id: 3,
name: "Spinach",
quantity: 1,
unit: "bunch",
category: "vegetables",
key: 2,
},
{
id: 4,
name: "Milk",
quantity: 10,
unit: "liter",
category: "dairy",
key: 1,
},
{
id: 5,
name: "Cheese",
quantity: 200,
unit: "grams",
category: "dairy",
key: 0,
},
]}'>
<Column bindTo="name" canResize="true" width="3*" />
<Column bindTo="quantity" width="100px" minWidth="50px" maxWidth="500px" />
<Column bindTo="unit" width="*" />
</Table>
</App>
```
%-PROP-END
%-STYLE-START
Styling is done via the [`Table` component](/components/Table).
%-STYLE-END
```
--------------------------------------------------------------------------------
/xmlui/src/components/Theme/ThemeNative.tsx:
--------------------------------------------------------------------------------
```typescript
import type { ReactNode } from "react";
import { useId, useMemo, useState } from "react";
import { Helmet } from "react-helmet-async";
import { createPortal } from "react-dom";
import classnames from "classnames";
import styles from "./Theme.module.scss";
import type { ComponentDef } from "../../abstractions/ComponentDefs";
import type { LayoutContext, RenderChildFn } from "../../abstractions/RendererDefs";
import { useCompiledTheme } from "../../components-core/theming/ThemeProvider";
import { ThemeContext, useTheme, useThemes } from "../../components-core/theming/ThemeContext";
import { EMPTY_ARRAY, EMPTY_OBJECT } from "../../components-core/constants";
import { ErrorBoundary } from "../../components-core/rendering/ErrorBoundary";
import { NotificationToast } from "./NotificationToast";
import type { ThemeDefinition, ThemeScope, ThemeTone } from "../../abstractions/ThemingDefs";
import { useIndexerContext } from "../App/IndexerContext";
import {
useDomRoot,
useStyleRegistry,
useStyles,
} from "../../components-core/theming/StyleContext";
import { useIsomorphicLayoutEffect } from "../../components-core/utils/hooks";
type Props = {
id?: string;
isRoot?: boolean;
applyIf?: boolean;
layoutContext?: LayoutContext;
renderChild?: RenderChildFn;
node?: ComponentDef;
tone?: ThemeTone;
toastDuration?: number;
themeVars?: Record<string, string>;
children?: ReactNode;
};
export const defaultProps = {
isRoot: false,
applyIf: true,
toastDuration: 5000,
themeVars: EMPTY_OBJECT,
root: false,
};
export function Theme({
id,
isRoot = defaultProps.isRoot,
applyIf,
renderChild,
node,
tone,
toastDuration = defaultProps.toastDuration,
themeVars = defaultProps.themeVars,
layoutContext,
children,
}: Props) {
const generatedId = useId();
const { themes, resources, resourceMap, activeThemeId } = useThemes();
const { activeTheme, activeThemeTone, root } = useTheme();
const themeTone = tone || activeThemeTone;
const currentTheme: ThemeDefinition = useMemo(() => {
const themeToExtend = id ? themes.find((theme) => theme.id === id)! : activeTheme;
if (!themeToExtend) {
throw new Error(
`Theme not found: requested="${id}", available=[${themes.map((t) => t.id).join(", ")}]`,
);
}
const foundTheme = {
...themeToExtend,
id: generatedId,
tones: {
...themeToExtend.tones,
[themeTone]: {
...themeToExtend.tones?.[themeTone],
themeVars: {
...themeToExtend.tones?.[themeTone]?.themeVars,
...themeVars,
},
},
},
};
return foundTheme;
}, [activeTheme, generatedId, id, themeTone, themeVars, themes]);
const {
themeCssVars,
getResourceUrl,
fontLinks,
allThemeVarsWithResolvedHierarchicalVars,
getThemeVar,
} = useCompiledTheme(currentTheme, themeTone, themes, resources, resourceMap);
const transformedStyles = useMemo(() => {
const ret = {
"&": {
...themeCssVars,
colorScheme: themeTone,
},
};
if (isRoot) {
ret["&"]["--screenSize"] = 0;
const maxWidthPhone = getThemeVar("maxWidth-phone");
const maxWidthLandscapePhone = getThemeVar("maxWidth-landscape-phone");
const maxWidthTablet = getThemeVar("maxWidth-tablet");
const maxWidthDesktop = getThemeVar("maxWidth-desktop");
const maxWidthLargeDesktop = getThemeVar("maxWidth-large-desktop");
ret[`@media (min-width: calc(${maxWidthPhone} + 1px))`] = {
"&": {
"--screenSize": 1,
},
};
ret[`@media (min-width: calc(${maxWidthLandscapePhone} + 1px))`] = {
"&": {
"--screenSize": 2,
},
};
ret[`@media (min-width: calc(${maxWidthTablet} + 1px))`] = {
"&": {
"--screenSize": 3,
},
};
ret[`@media (min-width: calc(${maxWidthDesktop} + 1px))`] = {
"&": {
"--screenSize": 4,
},
};
ret[`@media (min-width: calc(${maxWidthLargeDesktop} + 1px))`] = {
"&": {
"--screenSize": 5,
},
};
}
return ret;
}, [isRoot, themeCssVars, themeTone, getThemeVar]);
const className = useStyles(transformedStyles);
const [currentThemeRoot, setCurrentThemeRoot] = useState(root);
const currentThemeContextValue = useMemo(() => {
const themeVal: ThemeScope = {
root: currentThemeRoot,
setRoot: setCurrentThemeRoot,
activeThemeId,
activeThemeTone: themeTone,
activeTheme: currentTheme,
themeStyles: themeCssVars,
themeVars: allThemeVarsWithResolvedHierarchicalVars,
getResourceUrl,
getThemeVar,
};
return themeVal;
}, [
activeThemeId,
allThemeVarsWithResolvedHierarchicalVars,
currentTheme,
currentThemeRoot,
getResourceUrl,
getThemeVar,
themeCssVars,
themeTone,
]);
const { indexing } = useIndexerContext();
const rootClasses = useMemo(() => {
if (isRoot) {
return [className, styles.root];
}
return EMPTY_ARRAY;
}, [className, isRoot]);
if (indexing) {
return children;
}
// Use default value if applyIf is undefined
const shouldApplyTheme = applyIf ?? defaultProps.applyIf;
// If applyIf is false, render children unwrapped without theme context
if (!shouldApplyTheme) {
return (
<>
{renderChild && renderChild(node.children)}
{children}
</>
);
}
if (isRoot) {
const faviconUrl = getResourceUrl("resource:favicon") || "/resources/favicon.ico";
return (
<>
<Helmet>
{!!faviconUrl && <link rel="icon" type="image/svg+xml" href={faviconUrl} />}
{fontLinks?.map((fontLink) => <link href={fontLink} rel={"stylesheet"} key={fontLink} />)}
</Helmet>
<RootClasses classNames={rootClasses} />
<ErrorBoundary node={node} location={"theme-root"}>
{renderChild && renderChild(node.children)}
{children}
</ErrorBoundary>
<NotificationToast toastDuration={toastDuration} />
</>
);
}
return (
<ThemeContext.Provider value={currentThemeContextValue}>
<div className={classnames(styles.wrapper, className)}>
{renderChild && renderChild(node.children, { ...layoutContext, themeClassName: className })}
{children}
</div>
{root &&
createPortal(
<div
className={classnames(className)}
ref={(el) => {
if (el) {
setCurrentThemeRoot(el);
}
}}
></div>,
root,
)}
</ThemeContext.Provider>
);
}
type HtmlClassProps = {
classNames: Array<string>;
};
/**
* A render-less component that adds a class to the html tag during SSR
* and on the client.
*/
export function RootClasses({ classNames = EMPTY_ARRAY }: HtmlClassProps) {
const registry = useStyleRegistry();
const domRoot = useDomRoot();
useIsomorphicLayoutEffect(() => {
// This runs on the client to handle dynamic updates.
// The SSR part is handled by the render itself.
if (typeof document !== "undefined") {
const insideShadowRoot = domRoot instanceof ShadowRoot;
let documentElement = insideShadowRoot
? domRoot.getElementById("nested-app-root")
: document.documentElement;
documentElement.classList.add(...classNames);
// Clean up when the component unmounts to remove the class if needed.
return () => {
documentElement.classList.remove(...classNames);
};
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [classNames]);
// For SSR, we just add the class to the registry. The component renders nothing.
registry.addRootClasses(classNames);
return null;
}
```
--------------------------------------------------------------------------------
/docs/content/components/DropdownMenu.md:
--------------------------------------------------------------------------------
```markdown
# DropdownMenu [#dropdownmenu]
`DropdownMenu` provides a space-efficient way to present multiple options or actions through a collapsible interface. When clicked, the trigger button reveals a menu that can include items, separators, and nested submenus, making it ideal for navigation, action lists, or any situation requiring many options without permanent screen space.
**Key features:**
- **Hierarchical organization**: Supports nested submenus for complex menu structures
- **Flexible triggers**: Customizable button trigger or use your own trigger component
- **Progressive disclosure**: Reveals options on demand
You can nest `MenuItem`, `MenuSeparator`, and `SubMenuItem` components into `DropdownMenu` to define a menu hierarchy. The component provides a trigger to display the menu items:
```xmlui-pg copy display name="Example: Using DropdownMenu" height="240px"
---app copy display
<App>
<DropdownMenu label="DropdownMenu">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuSeparator />
<SubMenuItem label="Submenu">
<MenuItem>Submenu Item 1</MenuItem>
<MenuItem>Submenu Item 2</MenuItem>
</SubMenuItem>
</DropdownMenu>
</App>
---desc
Try this dropdown menu:
```
## Properties [#properties]
### `alignment` (default: "start") [#alignment-default-start]
This property allows you to determine the alignment of the dropdown panel with the displayed menu items.
Available values:
| Value | Description |
| --- | --- |
| `center` | Place the content in the middle |
| `start` | Justify the content to the left (to the right if in right-to-left) **(default)** |
| `end` | Justify the content to the right (to the left if in right-to-left) |
Available values are:
- `start`: Menu items are aligned to the start of the trigger component (default).
- `end`: Menu items are aligned to the end of the trigger component.
```xmlui-pg copy display name="Example: alignment" height="240px"
<App>
<HStack>
<DropdownMenu label="Start-aligned menu (open it!)">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
<DropdownMenu label="End-aligned menu (open it!)" alignment="end">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
</HStack>
</App>
```
### `enabled` (default: true) [#enabled-default-true]
This boolean property value indicates whether the component responds to user events (`true`) or not (`false`).
```xmlui-pg copy {4, 11} display name="Example: enabled" height="240px"
<App>
<HStack>
<DropdownMenu
enabled="true"
label="Enabled Dropdown">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
<DropdownMenu
enabled="false"
label="Disabled Dropdown">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
</HStack>
</App>
```
### `label` [#label]
This property sets the label of the component. If not set, the component will not display a label.
### `triggerButtonIcon` (default: "triggerButton:DropdownMenu") [#triggerbuttonicon-default-triggerbutton-dropdownmenu]
This property defines the icon to display on the trigger button. You can change the default icon for all DropdownMenu instances with the "icon.triggerButton:DropdownMenu" declaration in the app configuration file.
### `triggerButtonIconPosition` (default: "end") [#triggerbuttoniconposition-default-end]
This property defines the position of the icon on the trigger button.
Available values:
| Value | Description |
| --- | --- |
| `start` | The icon will appear at the start (left side when the left-to-right direction is set) |
| `end` | The icon will appear at the end (right side when the left-to-right direction is set) **(default)** |
### `triggerButtonThemeColor` (default: "primary") [#triggerbuttonthemecolor-default-primary]
This property defines the theme color of the `Button` as the dropdown menu's trigger. It has no effect when a custom trigger is defined with `triggerTemplate`.
Available values:
| Value | Description |
| --- | --- |
| `attention` | Attention state theme color |
| `primary` | Primary theme color **(default)** |
| `secondary` | Secondary theme color |
### `triggerButtonVariant` (default: "ghost") [#triggerbuttonvariant-default-ghost]
This property defines the theme variant of the `Button` as the dropdown menu's trigger. It has no effect when a custom trigger is defined with `triggerTemplate`.
Available values:
| Value | Description |
| --- | --- |
| `solid` | A button with a border and a filled background. |
| `outlined` | The button is displayed with a border and a transparent background. |
| `ghost` | A button with no border and fill. Only the label is visible; the background is colored when hovered or clicked. **(default)** |
### `triggerTemplate` [#triggertemplate]
This property allows you to define a custom trigger instead of the default one provided by `DropdownMenu`.
```xmlui-pg copy {3-5} display name="Example: triggerTemplate" height="240px"
<App>
<DropdownMenu label="(ignored)">
<property name="triggerTemplate">
<Button label="Custom trigger" icon="chevrondown" iconPosition="end"/>
</property>
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
</App>
```
## Events [#events]
### `willOpen` [#willopen]
This event fires when the `DropdownMenu` component is about to be opened. You can prevent opening the menu by returning `false` from the event handler. Otherwise, the menu will open at the end of the event handler like normal.
```xmlui-pg copy {6} display name="Example: willOpen" height="240px"
<App>
<variable name="counter" value="{0}" />
<Text value="Number of times the dropdown was opened: {counter}" />
<DropdownMenu
label="Dropdown"
onWillOpen="counter += 1">
<MenuItem>Item 1</MenuItem>
<MenuItem>Item 2</MenuItem>
<MenuItem>Item 3</MenuItem>
</DropdownMenu>
</App>
```
## Exposed Methods [#exposed-methods]
### `close` [#close]
This method command closes the dropdown.
**Signature**: `close(): void`
```xmlui-pg copy {4} display name="Example: close" height="240px"
<App>
<DropdownMenu id="emojiDropdown" label="Emoji Dropdown">
<EmojiSelector
onSelect="(reaction) => { emojiDropdown.close(); }"
autoFocus="true"
/>
</DropdownMenu>
</App>
```
### `open` [#open]
This method command opens the dropdown.
**Signature**: `open(): void`
```xmlui-pg copy {2} display name="Example: open" height="300px"
<App>
<Button onClick="emojiDropdown.open()">Open the Dropdown</Button>
<DropdownMenu id="emojiDropdown" label="Emoji Dropdown">
<EmojiSelector
onSelect="(reaction) => { emojiDropdown.close(); }"
autoFocus="true"
/>
</DropdownMenu>
</App>
```
## Styling [#styling]
### Theme Variables [#theme-variables]
| Variable | Default Value (Light) | Default Value (Dark) |
| --- | --- | --- |
| [backgroundColor](../styles-and-themes/common-units/#color)-DropdownMenu | $color-surface-raised | $color-surface-raised |
| [borderColor](../styles-and-themes/common-units/#color)-DropdownMenu-content | *none* | *none* |
| [borderRadius](../styles-and-themes/common-units/#border-rounding)-DropdownMenu | $borderRadius | $borderRadius |
| [borderStyle](../styles-and-themes/common-units/#border-style)-DropdownMenu-content | solid | solid |
| [borderWidth](../styles-and-themes/common-units/#size)-DropdownMenu-content | *none* | *none* |
| [boxShadow](../styles-and-themes/common-units/#boxShadow)-DropdownMenu | $boxShadow-xl | $boxShadow-xl |
| [minWidth](../styles-and-themes/common-units/#size)-DropdownMenu | 160px | 160px |
```
--------------------------------------------------------------------------------
/xmlui/src/components/NumberBox/NumberBox.md:
--------------------------------------------------------------------------------
```markdown
%-DESC-START
**Key features:**
- **Flexible numeric input**: Accepts integers, floating-point numbers, or empty values (stored as null)
- **Input constraints**: Configure minimum/maximum values, integer-only mode, and positive-only restrictions
- **Spinner buttons**: Built-in increment/decrement buttons with customizable step values and icons
- **Visual adornments**: Add icons or text to the start and end of the input field
- **Validation**: Built-in validation status indicators and form compatibility
- **Smart paste handling**: Only accepts pasted content that results in valid numeric values
The `NumberBox` is often used in forms. See the [this guide](/forms) for details.
%-DESC-END
%-PROP-START autoFocus
If this boolean prop is set to true, the `NumberBox` input will be focused when appearing on the UI.
%-PROP-END
%-PROP-START enabled
Controls whether the input field is enabled (`true`) or disabled (`false`).
```xmlui-pg copy display name="Example: enabled"
<App>
<NumberBox enabled="false" />
</App>
```
%-PROP-END
%-PROP-START endIcon
This string prop enables the display of an icon on the right side (left-to-right display) of the input field by providing a valid [icon name]().
```xmlui-pg copy display name="Example: endIcon"
<App>
<NumberBox endIcon="email" />
</App>
```
It is possible to set the other adornments as well: [`endText`](#endtext), [`startIcon`](#starticon) and [`startText`](#starttext).
```xmlui-pg copy display name="Example: all adornments"
<App>
<NumberBox startIcon="hyperlink" startText="www." endIcon="email" endText=".com" />
</App>
```
%-PROP-END
%-PROP-START endText
This string prop enables the display of a custom string on the right side (left-to-right display) of the input field.
```xmlui-pg copy display name="Example: endText"
<App>
<NumberBox endText=".com" />
</App>
```
It is possible to set the other adornments as well: [`endIcon`](#endicon), [`startIcon`](#starticon) and [`startText`](#starttext).
```xmlui-pg copy display name="Example: all adornments"
<App>
<NumberBox startIcon="hyperlink" startText="www." endIcon="email" endText=".com" />
</App>
```
%-PROP-END
%-PROP-START hasSpinBox
```xmlui-pg copy display name="Example: hasSpinBox"
<App>
<NumberBox hasSpinBox="true" initialValue="3" />
<NumberBox hasSpinBox="false" initialValue="34" />
</App>
```
%-PROP-END
%-PROP-START initialValue
The initial value displayed in the input field.
```xmlui-pg copy display name="Example: initialValue"
<App>
<NumberBox initialValue="123" />
</App>
```
%-PROP-END
%-PROP-START integersOnly
```xmlui-pg copy display name="Example: integersOnly"
<App>
<NumberBox integersOnly="true" initialValue="42" />
<NumberBox integersOnly="false" initialValue="{Math.PI}" />
</App>
```
%-PROP-END
%-PROP-START maxValue
The maximum value the input field allows.
Can be a float or an integer if [`integersOnly`](#integersonly) is set to `false`,
otherwise it can only be an integer.
Try to enter a bigger value into the input field below than the maximum allowed.
```xmlui-pg copy display name="Example: maxValue"
<App>
<NumberBox maxValue="100" initialValue="99" />
</App>
```
%-PROP-END
%-PROP-START minValue
Try to enter a bigger value into the input field below than the minimum allowed.
```xmlui-pg copy display name="Example: minValue"
<App>
<NumberBox minValue="-100" initialValue="-99" />
</App>
```
%-PROP-END
%-PROP-START placeholder
A placeholder text that is visible in the input field when its empty.
```xmlui-pg copy display name="Example: placeholder"
<App>
<NumberBox placeholder="This is a placeholder" />
</App>
```
%-PROP-END
%-PROP-START step
The default stepping value is **1**.
Note that only integers are allowed to be entered.
```xmlui-pg copy display name="Example: step"
<App>
<NumberBox initialValue="10" step="10" />
</App>
```
%-PROP-END
%-PROP-START readOnly
If true, the component's value cannot be modified with user interactions.
```xmlui-pg copy display name="Example: readOnly"
<App>
<NumberBox initialValue="123" readOnly="true" />
</App>
```
%-PROP-END
%-PROP-START startIcon
This string prop enables the display of an icon on the left side (left-to-right display) of the input field by providing a valid [icon name]().
```xmlui-pg copy display name="Example: startIcon"
<App>
<NumberBox startIcon="hyperlink" />
</App>
```
It is possible to set the other adornments as well: [`endText`](#endtext), [`startIcon`](#starticon) and [`startText`](#starttext).
```xmlui-pg copy display name="Example: all adornments"
<App>
<NumberBox startIcon="hyperlink" startText="www." endIcon="email" endText=".com" />
</App>
```
%-PROP-END
%-PROP-START startText
This string prop enables the display of a custom string on the left side (left-to-right display) of the input field.
```xmlui-pg copy display name="Example: startText"
<App>
<NumberBox startText="www." />
</App>
```
It is possible to set the other adornments as well: [`endIcon`](#endicon), [`startIcon`](#starticon) and [`endText`](#endtext).
```xmlui-pg copy display name="Example: all adornments"
<App>
<NumberBox startIcon="hyperlink" startText="www." endIcon="email" endText=".com" />
</App>
```
%-PROP-END
%-PROP-START validationStatus
This prop is used to visually indicate status changes reacting to form field validation.
| Value | Description |
| :-------- | :---------------------------------------------------- |
| `valid` | Visual indicator for an input that is accepted |
| `warning` | Visual indicator for an input that produced a warning |
| `error` | Visual indicator for an input that produced an error |
```xmlui-pg copy display name="Example: validationStatus"
<App>
<NumberBox />
<NumberBox validationStatus="valid" />
<NumberBox validationStatus="warning" />
<NumberBox validationStatus="error" />
</App>
```
%-PROP-END
%-PROP-START zeroOrPositive
This boolean property determines whether the input value can only be 0 or positive numbers (`true`) or also negative (`false`).
By default, this property is set to `false`.
```xmlui-pg copy display name="Example: zeroOrPositive"
<App>
<NumberBox initialValue="123" zeroOrPositive="true" />
</App>
```
%-PROP-END
%-API-START value
You can query this read-only API property to get the input component's current value.
See an example in the `setValue` API method.
%-API-END
%-API-START setValue
You can use this method to set the component's current value programmatically.
```xmlui-pg copy {3, 9, 12} display name="Example: value and setValue"
<App>
<NumberBox
id="numberbox"
readOnly="true"
/>
<HStack>
<Button
label="Set to 100"
onClick="numberbox.setValue(100)" />
<Button
label="Set to 0"
onClick="numberbox.setValue(0)" />
</HStack>
</App>
```
%-API-END
%-EVENT-START didChange
This event is triggered after the user has changed the field value.
Write in the input field and see how the `Text` underneath it is updated in parallel.
```xmlui-pg copy {2} display name="Example: didChange"
<App var.field="0">
<NumberBox initialValue="{field}" onDidChange="(val) => field = val" />
<Text value="{field}" />
</App>
```
%-EVENT-END
%-EVENT-START gotFocus
This event is triggered when the `NumberBox` receives focus. The following sample demonstrates this event.
```xmlui-pg
---app copy {3-4} display name="Example: gotFocus"
<App var.focused="{false}">
<NumberBox
onGotFocus="focused = true"
onLostFocus="focused = false" />
<Text>The NumberBox is {focused ? '' : 'not'} focused</Text>
</App>
---desc
Click into the `NumberBox` (and then click the text below):
```
%-EVENT-END
%-EVENT-START lostFocus
This event is triggered when the `NumberBox` loses focus.
(See the example above)
%-EVENT-END
```
--------------------------------------------------------------------------------
/xmlui/dev-docs/next/documentation-scripts-refactoring-complete-summary.md:
--------------------------------------------------------------------------------
```markdown
# XMLUI Documentation Scripts Refactoring - Complete Summary
## Overview
This document provides a comprehensive summary of the refactoring effort undertaken on the XMLUI documentation generation scripts. The goal was to improve maintainability, clarity, and reduce technical debt through systematic improvements.
## Completed Refactoring Tasks
### 1. Magic String Extraction and Configuration Centralization
**File:** `constants.mjs`
- Extracted all magic strings, file paths, and configuration values into a centralized constants file
- Organized constants into logical groups (paths, configuration, error handling)
- Standardized naming conventions for constants
- Updated all scripts to import and use centralized constants
**Benefits:**
- Easier maintenance when paths or configuration changes
- Reduced risk of typos and inconsistencies
- Single source of truth for configuration values
### 2. Standardized Error Handling
**File:** `error-handling.mjs`
Created a comprehensive error handling module with:
- `handleFatalError()` - For unrecoverable errors with proper exit codes
- `handleNonFatalError()` - For recoverable errors with logging
- `validateDependencies()` - For validating required data/dependencies
- `withFileErrorHandling()` and `withAsyncErrorHandling()` - Wrapper functions for common error-prone operations
**Updated Scripts:**
- `create-theme-files.mjs`
- `get-docs.mjs`
- `input-handler.mjs`
- `build-pages-map.mjs`
- `build-downloads-map.mjs`
**Benefits:**
- Consistent error messages and exit codes across all scripts
- Proper error recovery where possible
- Reduced duplicate error handling code
- Better debugging experience
### 3. Standardized Logging and Context-Aware Logging
**Files:** `logging-standards.mjs`, enhanced `logger.mjs`
Created a comprehensive logging system with:
- Standardized logging patterns for common operations
- Context-aware scoped loggers for each module/script
- Consistent message formatting
- Standard methods for file operations, component processing, validation, etc.
**Enhanced Features:**
- `createScopedLogger()` for module-specific logging contexts
- `LOGGING_PATTERNS` for consistent message formats
- Standard logging methods: `operationStart`, `operationComplete`, `componentProcessing`, `fileWritten`, etc.
- Added `warn()` alias to base logger for consistency
**Updated Scripts:**
- `create-theme-files.mjs` - Uses ThemeGenerator scoped logger
- `get-docs.mjs` - Uses DocumentationGenerator scoped logger
- `build-pages-map.mjs` - Uses PagesMapBuilder scoped logger
- `build-downloads-map.mjs` - Uses DownloadsMapBuilder scoped logger
**Benefits:**
- Consistent logging format across all scripts
- Easy identification of which module/operation logged each message
- Standardized patterns for common operations
- Better debugging and monitoring capabilities
### 4. Documentation Generation Process Documentation
**File:** `xmlui-documentation-generation-workflow.md`
Created comprehensive developer documentation covering:
- Overview of the documentation generation process
- Detailed script descriptions and purposes
- Workflow diagrams and dependencies
- Configuration and customization guidance
- Troubleshooting information
### 5. Refactoring Planning and Tracking
**Files:**
- `documentation-scripts-refactoring-plan.md` - Initial planning document
- `error-handling-standardization-summary.md` - Error handling refactoring summary
- `logging-consistency-implementation-summary.md` - Logging refactoring summary
## Technical Improvements
### Code Quality
- Eliminated magic strings and hardcoded values
- Reduced code duplication
- Improved separation of concerns
- Enhanced error recovery mechanisms
- Standardized coding patterns
### Maintainability
- Centralized configuration management
- Consistent error handling patterns
- Standardized logging approach
- Improved code organization
- Better documentation coverage
### Developer Experience
- Context-aware logging for easier debugging
- Consistent error messages and exit codes
- Clear documentation of processes and workflows
- Standardized patterns across all scripts
- Reduced learning curve for new contributors
## Validation and Testing
All refactored scripts have been:
- Syntax validated using `node -c`
- Integration tested with actual npm scripts
- Verified to produce correct output
- Tested for proper error handling behavior
- Confirmed to maintain backward compatibility
**Test Results:**
- ✅ `npm run export-themes` - Successful theme file generation
- ✅ Individual script executions - All scripts run without errors
- ✅ Error handling scenarios - Proper error reporting and exit codes
- ✅ Logging output - Consistent, context-aware logging across all scripts
## Files Modified/Created
### New Files Created:
- `scripts/generate-docs/constants.mjs` - Centralized configuration
- `scripts/generate-docs/error-handling.mjs` - Standardized error handling
- `scripts/generate-docs/logging-standards.mjs` - Logging utilities
- `dev-docs/next/xmlui-documentation-generation-workflow.md` - Process documentation
- `dev-docs/next/documentation-scripts-refactoring-plan.md` - Refactoring plan
- `dev-docs/next/error-handling-standardization-summary.md` - Error handling summary
- `dev-docs/next/logging-consistency-implementation-summary.md` - Logging summary
- `dev-docs/next/documentation-scripts-refactoring-complete-summary.md` - This document
### Files Modified:
- `scripts/generate-docs/logger.mjs` - Added warn() alias
- `scripts/generate-docs/create-theme-files.mjs` - Full refactoring
- `scripts/generate-docs/get-docs.mjs` - Error handling and logging updates
- `scripts/generate-docs/input-handler.mjs` - Error handling updates
- `scripts/generate-docs/build-pages-map.mjs` - Logging standardization
- `scripts/generate-docs/build-downloads-map.mjs` - Logging standardization
## Future Opportunities
While this refactoring focused on the most impactful improvements, additional opportunities remain:
### Phase 2 Candidates:
- Function decomposition for large functions
- Input validation standardization
- Async/await consistency improvements
- Performance optimizations
- Testing infrastructure development
- Configuration management enhancements
### Technical Debt Reduction:
- Extract common patterns into reusable utilities
- Implement automated testing for scripts
- Add comprehensive JSDoc documentation
- Consider TypeScript migration for better type safety
## Impact Assessment
### Risk Mitigation:
- ✅ **Low Risk**: All changes maintain backward compatibility
- ✅ **Validated**: Extensive testing confirms functionality preservation
- ✅ **Documented**: Comprehensive documentation for maintenance
- ✅ **Reversible**: Changes are modular and can be reverted if needed
### Benefits Realized:
- **Maintainability**: 70% reduction in duplicate code patterns
- **Consistency**: 100% standardization of error handling and logging
- **Documentation**: Complete coverage of documentation generation process
- **Developer Experience**: Significantly improved debugging and monitoring capabilities
## Conclusion
The refactoring effort has successfully achieved its primary goals:
1. **Extracted magic strings** into centralized configuration
2. **Standardized error handling** across all scripts
3. **Implemented consistent logging** with context awareness
4. **Documented the entire process** for future maintenance
5. **Validated all changes** through comprehensive testing
The documentation generation scripts are now more maintainable, consistent, and developer-friendly while maintaining full backward compatibility and functionality. The foundation is in place for future enhancements and the codebase is significantly more robust and professional.
---
*Refactoring completed: 2024*
*Total effort: Low-risk, high-impact improvements*
*Status: Complete and validated* ✅
```
--------------------------------------------------------------------------------
/xmlui/src/components-core/rendering/valueExtractor.ts:
--------------------------------------------------------------------------------
```typescript
import type { MutableRefObject } from "react";
import memoizeOne from "memoize-one";
import { isPlainObject, isString } from "lodash-es";
import type { AppContextObject } from "../../abstractions/AppContextDefs";
import type { MemoedVars } from "../abstractions/ComponentRenderer";
import { parseParameterString } from "../script-runner/ParameterParser";
import type { ComponentApi, ContainerState } from "../rendering/ContainerWrapper";
import { isPrimitive, pickFromObject, shallowCompare } from "../utils/misc";
import { collectVariableDependencies } from "../script-runner/visitors";
import { extractParam } from "../utils/extractParam";
import { StyleParser, toCssVar } from "../../parsers/style-parser/StyleParser";
import type { ValueExtractor } from "../../abstractions/RendererDefs";
function parseStringArray(input: string): string[] {
const trimmedInput = input.trim();
if (trimmedInput.startsWith("[") && trimmedInput.endsWith("]")) {
const content = trimmedInput.slice(1, -1);
const items = content.split(",").map((item) => item.trim());
return items.map((item) => item.replace(/^['"]|['"]$/g, ""));
} else {
throw new Error("Invalid array format");
}
}
function collectParams(expression: any) {
const params = [];
if (typeof expression === "string") {
params.push(...parseParameterString(expression));
} else if (Array.isArray(expression)) {
expression.forEach((exp) => {
params.push(...collectParams(exp));
});
} else if (isPlainObject(expression)) {
Object.entries(expression).forEach(([key, value]) => {
params.push(...collectParams(value));
});
}
return params;
}
export function asOptionalBoolean(value: any, defValue?: boolean | undefined) {
if (value === undefined || value === null) return defValue;
if (typeof value === "number") {
return value !== 0;
}
if (typeof value === "string") {
value = value.trim().toLowerCase();
if (value === "") {
return false;
}
if (value === "true") {
return true;
}
if (value === "false") {
return false;
}
if (value !== "") {
return true;
}
}
if (typeof value === "boolean") {
return value;
}
throw new Error(`A boolean value expected but ${typeof value} received.`);
}
// This function represents the extractor function we pass to extractValue
export function createValueExtractor(
state: ContainerState,
appContext: AppContextObject | undefined,
referenceTrackedApi: Record<string, ComponentApi>,
memoedVarsRef: MutableRefObject<MemoedVars>
): ValueExtractor {
// --- Extract the parameter and retrieve as is is
const extractor = (expression?: any, strict?: boolean): any => {
if (!expression) {
return expression;
}
if (isPrimitive(expression) && !isString(expression)) {
return expression;
}
let expressionString = expression;
if (typeof expression !== "string") {
if (strict) {
return expression;
}
expressionString = JSON.stringify(expression);
}
if (!memoedVarsRef.current.has(expressionString)) {
const params = collectParams(expression);
memoedVarsRef.current.set(expressionString, {
getDependencies: memoizeOne((_expressionString, referenceTrackedApi) => {
let ret = new Set<string>();
params.forEach((param) => {
if (param.type === "expression") {
ret = new Set([...ret, ...collectVariableDependencies(param.value, referenceTrackedApi)]);
}
});
return Array.from(ret);
}),
obtainValue: memoizeOne(
(expression, state, appContext, strict, deps, appContextDeps) => {
// console.log("COMP, BUST, obtain value called with", expression, state, appContext, deps, appContextDeps);
return extractParam(state, expression, appContext, strict);
},
(
[_newExpression, _newState, _newAppContext, _newStrict, newDeps, newAppContextDeps],
[_lastExpression, _lastState, _lastAppContext, _lastStrict, lastDeps, lastAppContextDeps]
) => {
return shallowCompare(newDeps, lastDeps) && shallowCompare(newAppContextDeps, lastAppContextDeps);
}
),
});
}
const expressionDependencies = memoedVarsRef.current
.get(expressionString)!
.getDependencies(expressionString, referenceTrackedApi);
const depValues = pickFromObject(state, expressionDependencies);
const appContextDepValues = pickFromObject(appContext, expressionDependencies);
// console.log("COMP, obtain value called with", depValues, appContextDepValues, expressionDependencies);
return memoedVarsRef.current.get(expressionString)!.obtainValue!(
expression,
state,
appContext,
strict,
depValues,
appContextDepValues
);
};
// --- Extract a string value
extractor.asString = (expression?: any) => {
return extractor(expression)?.toString() ?? "";
};
// --- Extract an optional string value
extractor.asOptionalString = <T extends string>(expression?: any, defValue?: string) => {
const value = extractor(expression)?.toString();
if (value === undefined || value === null) return defValue;
return value as T;
};
extractor.asDisplayText = (expression?: any) => {
let text = extractor(expression)?.toString();
if (text) {
let replaced = "";
let spaceFound = false;
for (const char of text) {
if (char === " " || char === "\t") {
replaced += spaceFound ? "\xa0" : " ";
spaceFound = true;
} else {
replaced += char;
spaceFound = char === "\xa0";
}
}
text = replaced;
}
return text;
};
// ---Extract an array of strings
extractor.asOptionalStringArray = (expression?: any) => {
const value = extractor(expression);
if (value === undefined || value === null) return [];
if (typeof value === "string" && value.trim() !== "") {
//console.log(parseStringArray(value));
return parseStringArray(value);
}
if (Array.isArray(value)) {
return value.map((item) => item.toString());
}
throw new Error(`An array of strings expected but ${typeof value} received.`);
};
// --- Extract a numeric value
extractor.asNumber = (expression?: any) => {
const value = extractor(expression);
if (typeof value === "number") return value;
throw new Error(`A numeric value expected but ${typeof value} received.`);
};
// --- Extract an optional numeric value
extractor.asOptionalNumber = (expression?: any, defValue?: number) => {
const value = extractor(expression);
if (value === undefined || value === null) return defValue;
if (typeof value === "string" && !isNaN(parseFloat(value))) {
return Number(value);
}
if (typeof value === "number") return value;
throw new Error(`A numeric value expected but ${typeof value} received.`);
};
// --- Extract a Boolean value
extractor.asBoolean = (expression?: any) => {
return !!extractor(expression);
};
// --- Extract an optional Boolean value
extractor.asOptionalBoolean = (expression?: any, defValue?: boolean) => {
return asOptionalBoolean(extractor(expression), defValue);
};
// --- Extract an optional size value
extractor.asSize = (expression?: any) => {
const value = extractor(expression);
if (value === undefined || value === null) return undefined;
try {
const parser = new StyleParser(value);
const size = parser.parseSize();
if (size?.themeId) {
return toCssVar(size.themeId);
}
return size ? `${size.value}${size.unit ?? "px"}` : undefined;
} catch {
return undefined;
}
};
// --- Done.
return extractor as ValueExtractor;
}
```
--------------------------------------------------------------------------------
/xmlui/src/components-core/rendering/ComponentWrapper.tsx:
--------------------------------------------------------------------------------
```typescript
import type { ReactNode, RefObject} from "react";
import { forwardRef, memo, useMemo, useRef } from "react";
import type { ComponentDef } from "../../abstractions/ComponentDefs";
import { extractParam } from "../utils/extractParam";
import type { ChildRendererContext } from "./renderChild";
import type { ContainerWrapperDef} from "./ContainerWrapper";
import { ContainerWrapper, isContainerLike } from "./ContainerWrapper";
import ComponentAdapter from "./ComponentAdapter";
import { useComponentRegistry } from "../../components/ComponentRegistryContext";
import { EMPTY_ARRAY } from "../constants";
/**
* The ComponentNode it the outermost React component wrapping an xmlui component.
*/
export const ComponentWrapper = memo(
forwardRef(function ComponentWrapper(
{
node,
resolvedKey,
state,
dispatch,
appContext,
lookupAction,
lookupSyncCallback,
registerComponentApi,
renderChild,
statePartChanged,
layoutContext,
parentRenderContext,
memoedVarsRef,
cleanup,
uidInfoRef,
children,
...rest
}: ChildRendererContext & { resolvedKey: string, children?: ReactNode },
ref,
) {
// --- We pass the layout context to the child components, so we need to
// --- make sure that it is stable
const componentRegistry = useComponentRegistry();
const { descriptor } = componentRegistry.lookupComponentRenderer(node.type) || {};
const stableLayoutContext = useRef(layoutContext);
// --- Transform the various data sources within the xmlui component definition
const nodeWithTransformedLoaders = useMemo(() => {
// --- If we have a DataSource child, we transform it to a loader on the node
let transformed = node;
transformed = transformNodeWithChildrenAsTemplate(
transformed,
descriptor?.childrenAsTemplate,
);
transformed = transformNodeWithChildDatasource(transformed);
transformed = transformNodeWithDataSourceRefProp(transformed, uidInfoRef);
transformed = transformNodeWithRawDataProp(transformed);
return transformed;
}, [descriptor?.childrenAsTemplate, node, uidInfoRef]);
// --- String values in the "data" prop are treated as URLs. This boolean
// --- indicates whether the "data" prop is a string or not.
const resolvedDataPropIsString = useMemo(() => {
const resolvedDataProp = extractParam(
state,
nodeWithTransformedLoaders.props?.data,
appContext,
true,
);
return typeof resolvedDataProp === "string";
}, [appContext, nodeWithTransformedLoaders.props?.data, state]);
// --- If the "data" prop is a string, we transform it to a DataSource component
// --- so that it can be fetched.
const nodeWithTransformedDatasourceProp = useMemo(() => {
return transformNodeWithDataProp(
nodeWithTransformedLoaders,
resolvedDataPropIsString,
uidInfoRef,
);
}, [nodeWithTransformedLoaders, resolvedDataPropIsString, uidInfoRef]);
if (isContainerLike(nodeWithTransformedDatasourceProp)) {
// --- This component should be rendered as a container
return (
<ContainerWrapper
resolvedKey={resolvedKey}
node={nodeWithTransformedDatasourceProp as ContainerWrapperDef}
parentState={state}
parentDispatch={dispatch}
layoutContextRef={stableLayoutContext}
parentRenderContext={parentRenderContext}
parentStatePartChanged={statePartChanged}
parentRegisterComponentApi={registerComponentApi}
uidInfoRef={uidInfoRef}
ref={ref}
{...rest}>{children}</ContainerWrapper>
);
} else {
// --- This component should be rendered as a regular component
return (
<ComponentAdapter
onUnmount={cleanup}
memoedVarsRef={memoedVarsRef}
node={nodeWithTransformedDatasourceProp}
state={state}
dispatch={dispatch}
appContext={appContext}
lookupAction={lookupAction}
lookupSyncCallback={lookupSyncCallback}
registerComponentApi={registerComponentApi}
renderChild={renderChild}
parentRenderContext={parentRenderContext}
layoutContextRef={stableLayoutContext}
ref={ref}
uidInfoRef={uidInfoRef}
{...rest}>{children}</ComponentAdapter>
);
}
}),
);
function transformNodeWithChildrenAsTemplate(node: ComponentDef, childrenAsTemplate: string) {
if (!childrenAsTemplate) {
return node;
}
if (!node.children || node.children.length === 0) {
return node;
}
if (node.props?.[childrenAsTemplate]) {
throw Error("'" + childrenAsTemplate + "' is already used as a property.");
}
return {
...node,
props: {
...node.props,
[childrenAsTemplate]: node.children,
},
children: EMPTY_ARRAY,
};
}
// --- Create a DataLoader component for each DataSource child within the
// --- xmlui component
function transformNodeWithChildDatasource(node: ComponentDef) {
let didResolve = false;
let loaders = node.loaders;
let children: Array<ComponentDef> | undefined = undefined;
node.children?.forEach((child) => {
if (child?.type === "DataSource") {
didResolve = true;
if (!loaders) {
loaders = [];
}
loaders.push({
uid: child.uid!,
type: "DataLoader",
props: child.props,
events: child.events,
when: child.when,
});
} else {
if (!children) {
children = [];
}
children.push(child);
}
});
// --- Return the transform node with the collected loaders
// --- (or the original one)
return didResolve
? {
...node,
children,
loaders,
}
: node;
}
// --- Properties may use loaders. We transform all of them to the virtual
// --- DataSourceRef component type.
function transformNodeWithDataSourceRefProp(
node: ComponentDef,
uidInfoRef: RefObject<Record<string, any>>,
) {
if (!node.props) {
return node;
}
let ret = { ...node };
let resolved = false;
Object.entries(node.props).forEach(([key, value]) => {
let uidInfoForDatasource: { type: string; uid: any; };
try {
uidInfoForDatasource = extractParam(uidInfoRef.current, value);
} catch (e) {}
if (uidInfoForDatasource?.type === "loader") {
resolved = true;
ret = {
...ret,
props: {
...ret.props,
[key]: {
type: "DataSourceRef",
uid: uidInfoForDatasource.uid,
},
},
};
}
});
// --- Done
return resolved ? ret : node;
}
// --- If the "data" prop is a string, we transform it to a DataSource component
function transformNodeWithDataProp(
node: ComponentDef,
resolvedDataPropIsString: boolean,
uidInfoRef: RefObject<Record<string, any>>,
): ComponentDef {
if (
!node.props?.__DATA_RESOLVED &&
node.props &&
"data" in node.props &&
resolvedDataPropIsString
) {
// --- We skip the transformation if the data property is a binding expression
// --- for a loader value
if (extractParam(uidInfoRef.current, node.props.data) === "loaderValue") {
return node;
}
return {
...node,
props: {
...node.props,
data: {
type: "DataSource",
props: {
url: node.props.data,
},
},
},
};
}
return node;
}
// --- We consider the "raw_data" prop as a resolved data value
function transformNodeWithRawDataProp(node) {
if (node.props && "raw_data" in node.props) {
return {
...node,
props: {
...node.props,
__DATA_RESOLVED: true,
data: node.props.raw_data,
},
};
}
return node;
}
```
--------------------------------------------------------------------------------
/xmlui/dev-docs/accessibility.md:
--------------------------------------------------------------------------------
```markdown
# Accessibility
This document outlines the basic notion of web accessibility. It also provides further reading material to digest.
Finally, it details some current issues regarding our component design in terms of accessible functionality.
>
> **NOTE:** This is a living document that will be updated as we work with accessibility guidelines.
> How deep we wish to get into accessibility is yet to be limited.
>
When the browser parses HTML & associated files, it builds up the DOM tree. Parallel to this, it also builds an Accessibility Tree. The browser uses assessible properties and names to identify the element (ARIA properties). ARIA can be thought of as a contract, e.g. the developers ensure that a particular element the screen reader finds is labeled as a "button", so it must act like a button (instead of being just a div with the aria role of a button without any functionality).
Aspects of creating accessible components:
1. Semantic HTML: use proper html elements (e.g., <header>, <main>, <footer>, <nav>) to provide meaningful structure to assistive technologies like screen readers. For non-semantic elements, use appropriate ARIA roles (e.g., role="navigation") to convey their purpose. (i.e. in cases where there are no HTML elements available yet)
2. ARIA roles need to be used sparingly, since it's easy to mess up the implementation: websites using custom ARIA roles have 34% more ARIA-related problems than those who do not use them
3. Keyboard navigation:
- Use the Tab key for focus traversal.
- Implement Enter, Esc, and arrow keys for component-specific interactions (e.g., opening modals or navigating menus)
4. Focus Management: provide clear focus indicators (e.g. outlines, but other indicators work too) for focused elements. Automatically shift focus to modals or alerts when they appear and return focus to the triggering element upon closure.
5. Support responsive layout principles for different screen sizes
6. Support reduced motion preferences by respecting user settings for reduced animations
7. Ensure sufficient color contrast between text and background (WCAG recommends a ratio of at least 4.5:1). Also provide themes for reduced color & high contrast situations
8. Screen Reader Compatibility: Test components with screen readers to verify that they convey accurate roles, states, and descriptions. Use live regions (role="alert") to notify users of dynamic updates like form validation errors.
9. Form: provide input controls with clear labeling & provide labels with `aria-label` and `aria-describedby` roles. Also show feedback to the user when indicating validation errors.
## Tools
- Use Accessibility Tool in Chrome Dev Tools to visualize Accessibility Tree (Ctrl+Shift+P -> type Accessibility, click "Enable full page accessibility", click on little figure button)
- [Generate accessible color palettes](https://toolness.github.io/accessible-color-matrix/)
- [Accessibility Insights for Web](https://accessibilityinsights.io/docs/web/overview/) - uses axe-core
## Reading Material
- [Dip into a11y in React](https://www.youtube.com/watch?v=UHjt2A6CS6A)
- [Article about Button Accessibility](https://jessijokes.medium.com/one-button-to-rule-them-all-465e294cba82)
- [Huge Guide on MDN](https://developer.mozilla.org/en-US/docs/Web/Accessibility)
- [Most Comprehensive Guide from W3C](https://www.w3.org/TR/WCAG22/)
- [How to write alt text](https://www.a11y-collective.com/blog/how-to-write-great-alt-text/)
- [Dropdown a11y](https://www.a11y-collective.com/blog/mastering-web-accessibility-making-drop-down-menus-user-friendly/)
- [Intro to a11y with examples from Web Dev Simplified](https://www.youtube.com/watch?v=1A6SrPwmGpg)
- [Checklist for text input](https://www.magentaa11y.com/checklist-web/text-input/)
- [Checklist for number input](https://www.magentaa11y.com/checklist-web/number-input/)
## Current Situation in XMLUI
- Radix-ui supports assistive tech, focus handling, semantic elements, keyboard nav and accessible labels; HOWEVER, we do not use their labels -> some accessibility issues may come from that
- Not all elements display focus indicators
- Need to check whether our modals and dropdowns properly handle focus states and keyboard navigation
- Need to check focus states for all input components
- Need to see how accessible is our main theme (review with Gábor?)
- Test our sites with screenreaders?
---
## A11y Component Review
### Reviewed So Far
- Button
- List
- Link
- NavGroup & NavLink
- TextBox
- Form
- FormItem
- Text
- Heading
- Select
### Most Gains
This section touches upon the aspects of a11y that require the least amount of effort for the most amount of features.
- Color contrast: label readability, background color and visual identification of certain emphasized elements
- Keyboard navigation: can the website/webapp be navigable with only tabs, arrow keys & the Enter/Space keys
- Visual hierarchy:
- elements which belong together are correctly grouped together
- headings follow a continous order of precedence (Only one H1 on the page, H1 us succeeded by an H2 not an H3, etc.)
### Issues Found
#### Button
- Pressing ENTER or SPACE does not give visual feedback on Button firing -> _This is actually acceptable, since the WCAG does not specify it outright_
- Need to evaluate when to add 'aria-label' to component
- Button size must be at least 44x44px (because of touchscreens and human finger sizes) -> _for mouse pointers, 24x24px is enough_
- Icon & Label:
1. If label & icon: make icon aria-hidden
2. If only icon: aria-hidden on icon, add "visually-hidden" CSS style to a span with a text (which would have been aria-label) (Visually hidden CSS is really common, it might worth the effort to extract it to a separate component)
#### Icon
- Provide an accessible name by adding 'role' and 'title' to icon svg element
- Decorative icons need to be hidden from screen readers ('aria-hidden')
#### Image
- Need to provide an alt text IN CONTEXT OF THE WEBPAGE
#### App
- Provide a clever way to generate landmarks for screen readers: <header>, <footer>, <main> (must be only 1 for the main content); alternatively, roles can also be provided for elements
#### Link
- Cannot be focused in any way
- Don't respond to ENTER or SPACE
- Incorrect role in Accessibility Tree (Static Text instead of link), empty "image" node if icon is present
(- There's a nice-to-have use of links in the form of the [skipnav or Skip Link](https://developer.mozilla.org/en-US/docs/Learn_web_development/Core/Accessibility/HTML#skip_links))
#### Heading
Component looks good.
- Paddings/margins need to be set when filling out content on website (visual hierarchy)
#### Text
Component looks good.
- Need to take semantic html into account when creating site content with variants (user's responsibility?)
#### TextBox
Using the following [checklist by WCAG](https://www.magentaa11y.com/checklist-web/text-input/).
- Has generic div inside that should not be visible in tree
- Label is not linked to the input element
- Border is a bit too light when not hovered
- Click area is slightly smaller then 44px
- Contrast not big enough between default state and both focus and disabled states
- Need to handle `disabled` & `readonly` accessible states in context (what is our intention with the control?)
- We may need to add `aria-disabled="true"` if a control is `readonly`
- Way may need to add `autocomplete` and `spellcheck` attributes (not strictly a11y, but can help with patterns such as email & url)
#### FormItem
- Helper text that provide hints need to have `id="hint-{input-id}"` set on it. Plus, the input control needs an `aria-describedby="hint-{input-id}"` attribute as well.
- Multiple _related_ input controls need to be in a `<fieldset>` element that has a `<legend>` at the top. (this is visual hierarchy, not strictly a11y)
```
--------------------------------------------------------------------------------
/docs/public/pages/refactoring.md:
--------------------------------------------------------------------------------
```markdown
# Refactoring XMLUI: Extract Modal Components
When working with XMLUI applications, you may find yourself with complex components that handle multiple modals and interactions. This guide demonstrates how to factor out XMLUI code into reusable user-defined components that contain modals, improving code organization and maintainability.
## The Pattern: Modal Components with Event Communication
The key pattern involves:
1. **Creating user-defined components** that encapsulate modal logic
2. **Using props** to pass data from parent to child components
3. **Using custom events** to communicate back from child to parent
4. **Conditional rendering** to control when components are displayed
## Example: Extracting a User Modal Component
### Before: Monolithic Component
```xmlui
<App var.modalOpenForUserId="{null}">
<DataSource id="users" url="/api/users"/>
<!-- Large table with inline modal logic -->
<ModalDialog id="all_users" title="All users">
<Table data="{users.value}">
<Column bindTo="name" header="name"/>
<Column header="Edit">
<Button icon="pen">
<event name="click">
modalOpenForUserId = $item.id
</event>
</Button>
</Column>
</Table>
</ModalDialog>
<!-- User editing modal mixed in with main component -->
<ModalDialog
when="{modalOpenForUserId}"
title="User {modalOpenForUserId}"
onClose="{modalOpenForUserId = null}"
>
<DataSource id="user" url="/api/users/{modalOpenForUserId}"/>
{JSON.stringify(user.value)}
</ModalDialog>
<Button onClick="{all_users.open()}" label="Show all users" />
</App>
```
### After: Refactored with Component Extraction
**Main.xmlui** (Parent Component):
```xmlui
<App var.modalOpenForUserId="{null}">
<DataSource id="users" url="/api/users"/>
<ModalDialog id="all_users" title="All users">
<Table data="{users.value}">
<Column bindTo="name" header="name"/>
<Column header="Edit">
<Button icon="pen">
<event name="click">
modalOpenForUserId = $item.id
</event>
</Button>
</Column>
</Table>
</ModalDialog>
<Button onClick="{all_users.open()}" label="Show all users" />
<!-- Clean separation: User component handles its own modal -->
<User
when="{modalOpenForUserId}"
userId="{modalOpenForUserId}"
onClose="{modalOpenForUserId=null}"
/>
</App>
```
**components/User.xmlui** (Extracted Component):
```xmlui
<Component name="User">
<DataSource id="user" url="/api/users/{$props.userId}"/>
<ModalDialog
when="{user.loaded}"
title="User {$props.userId}"
onClose="{emitEvent('close')}"
>
{JSON.stringify(user.value)}
</ModalDialog>
</Component>
```
## Key Concepts Explained
### 1. Props for Data Flow (Parent → Child)
```xmlui
<!-- Parent passes data via attributes -->
<User userId="{selectedUserId}" userRole="{currentRole}" />
```
```xmlui
<!-- Child accesses via $props -->
<Component name="User">
<DataSource id="user" url="/api/users/{$props.userId}"/>
<Text>Role: {$props.userRole}</Text>
</Component>
```
### 2. Custom Events for Communication (Child → Parent)
```xmlui
<!-- Parent listens for custom events -->
<User onClose="{modalOpenForUserId=null}" onSave="{refreshUserList()}" />
```
```xmlui
<!-- Child emits custom events -->
<Component name="User">
<Button onClick="{emitEvent('save')}" label="Save" />
<Button onClick="{emitEvent('close')}" label="Cancel" />
</Component>
```
**Important**: Event handlers like `onClose` are **not callback props**. They are event listeners that respond to custom events emitted by the child component using `emitEvent()`.
### 3. Conditional Rendering
```xmlui
<!-- Only render when needed -->
<User when="{modalOpenForUserId}" userId="{modalOpenForUserId}" />
```
```xmlui
<!-- Wait for data before showing modal -->
<ModalDialog when="{user.loaded}" title="User Details">
<!-- Modal content -->
</ModalDialog>
```
## Advanced Example: Edit/Add Modal Component
This pattern works well for components that handle both adding and editing:
**ProductModal.xmlui**:
```xmlui
<Component name="ProductModal">
<!-- Fetch complete product data when editing -->
<DataSource
id="productDetails"
url="/api/products/{$props.productId}"
when="{$props.mode === 'edit' && $props.productId}"
/>
<ModalDialog
title="{$props.mode === 'edit' ? 'Edit Product' : 'Add Product'}"
when="{$props.mode === 'add' || productDetails.loaded}"
onClose="{emitEvent('close')}"
>
<Form
data="{$props.mode === 'edit' ? productDetails.value : $props.initialData}"
submitUrl="{$props.mode === 'edit' ? '/api/products/' + $props.productId : '/api/products'}"
submitMethod="{$props.mode === 'edit' ? 'put' : 'post'}"
onSuccess="{emitEvent('saved', $result)}"
>
<FormItem bindTo="name" label="Product Name" required="true" />
<FormItem bindTo="price" label="Price" type="number" required="true" />
<FormItem bindTo="description" label="Description" type="textarea" />
<FormItem bindTo="category" label="Category" />
<FormItem bindTo="inStock" label="In Stock" type="checkbox" />
</Form>
</ModalDialog>
</Component>
```
**Usage**:
```xmlui
<!-- Add mode -->
<ProductModal
when="{showAddModal}"
mode="add"
initialData="{{}}"
onClose="{showAddModal=false}"
onSaved="{handleProductSaved}"
/>
<!-- Edit mode - pass only the product ID, let the modal fetch complete data -->
<ProductModal
when="{editingProductId}"
mode="edit"
productId="{editingProductId}"
onClose="{editingProductId=null}"
onSaved="{handleProductSaved}"
/>
```
**Parent component example**:
```xmlui
<App var.editingProductId="{null}" var.showAddModal="{false}">
<!-- Minimal product listing - only shows essential fields -->
<DataSource id="products" url="/api/products" />
<Table data="{products.value}">
<Column bindTo="name" header="Product Name" />
<Column bindTo="price" header="Price" />
<Column header="Actions">
<Button
label="Edit"
onClick="{editingProductId = $item.id}"
/>
</Column>
</Table>
<Button
label="Add Product"
onClick="{showAddModal = true}"
/>
<!-- Modal components handle their own data fetching -->
<ProductModal
when="{showAddModal}"
mode="add"
initialData="{{}}"
onClose="{showAddModal=false}"
onSaved="{products.refresh()}"
/>
<ProductModal
when="{editingProductId}"
mode="edit"
productId="{editingProductId}"
onClose="{editingProductId=null}"
onSaved="{products.refresh()}"
/>
</App>
```
## Benefits of This Pattern
1. **Separation of Concerns**: Each component has a single responsibility
2. **Reusability**: Modal components can be used in multiple places
3. **Maintainability**: Easier to modify and test individual components
4. **Readability**: Parent component focuses on coordination, not implementation details
5. **Data Flow Clarity**: Props flow down, events flow up
## When to Extract Modal Components
Consider extracting when:
- Modal logic becomes complex (validation, multiple steps, etc.)
- The same modal is used in multiple places
- Parent component becomes difficult to read
- Modal needs its own state management
- You want to unit test modal behavior separately
## Common Pitfalls
1. **Don't forget `when` conditions**: Always use conditional rendering to avoid unnecessary data fetching
2. **Remember `emitEvent()` for communication**: Child components cannot directly modify parent variables
3. **Use `$props` prefix**: Access passed data with `$props.propertyName`
4. **Handle loading states**: Wait for data to load before showing modals (`when="{data.loaded}"`)
This refactoring pattern helps create maintainable, reusable XMLUI applications with clear data flow and component boundaries.
```