This is page 102 of 183. Use http://codebase.md/xmlui-org/xmlui/tools/vscode/resources/assets/img/bg-iphone-14-pro.jpg?lines=true&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-optimized.yml
│ ├── 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
│ ├── package.json
│ ├── public
│ │ ├── blog
│ │ │ ├── images
│ │ │ │ ├── an-advanced-codefence.gif
│ │ │ │ ├── an-advanced-codefence.mp4
│ │ │ │ ├── blog-page-component.png
│ │ │ │ ├── blog-scrabble.png
│ │ │ │ ├── codefence-runner.png
│ │ │ │ ├── integrated-blog-search.png
│ │ │ │ ├── lorem-ipsum.png
│ │ │ │ ├── playground-checkbox-source.png
│ │ │ │ ├── playground.png
│ │ │ │ ├── use-xmlui-mcp-to-find-a-howto.png
│ │ │ │ └── xmlui-demo-gallery.png
│ │ │ ├── introducing-xmlui.md
│ │ │ ├── lorem-ipsum.md
│ │ │ ├── newest-post.md
│ │ │ ├── older-post.md
│ │ │ ├── xmlui-playground.md
│ │ │ └── xmlui-powered-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
│ │ ├── FancyButton.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
│ │ │ │ ├── control-cache-invalidation.md
│ │ │ │ ├── debounce-user-input-for-api-calls.md
│ │ │ │ ├── debounce-with-changelistener.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
│ ├── tsconfig.json
│ ├── 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
│ ├── 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
│ │ └── 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
│ ├── 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
│ ├── 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
│ ├── 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
│ ├── 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
│ ├── xmlui-spreadsheet
│ │ ├── .gitignore
│ │ ├── demo
│ │ │ └── Main.xmlui
│ │ ├── index.html
│ │ ├── index.ts
│ │ ├── meta
│ │ │ └── componentsMetadata.ts
│ │ ├── package.json
│ │ └── src
│ │ ├── index.tsx
│ │ ├── Spreadsheet.tsx
│ │ └── SpreadsheetNative.tsx
│ └── 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.spec.ts
│ │ ├── HeroSection.tsx
│ │ └── HeroSectionNative.tsx
│ ├── index.tsx
│ ├── ScrollToTop
│ │ ├── ScrollToTop.module.scss
│ │ ├── ScrollToTop.tsx
│ │ └── ScrollToTopNative.tsx
│ └── vite-env.d.ts
├── playwright.config.ts
├── 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.cjs
│ ├── 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
├── 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.js
│ ├── 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.js
│ ├── 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
│ │ │ ├── index.ts
│ │ │ ├── ModalDialogDriver.ts
│ │ │ ├── NumberBoxDriver.ts
│ │ │ ├── TextBoxDriver.ts
│ │ │ ├── TimeInputDriver.ts
│ │ │ ├── TimerDriver.ts
│ │ │ └── TreeDriver.ts
│ │ ├── fixtures.ts
│ │ ├── index.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
--------------------------------------------------------------------------------
/docs/content/components/DateInput.md:
--------------------------------------------------------------------------------
```markdown
1 | # DateInput [#dateinput]
2 |
3 | `DateInput` provides a text-based date input interface for selecting single dates or date ranges, with direct keyboard input similar to TimeInput. It offers customizable formatting and validation options without dropdown calendars.
4 |
5 | **Key features:**
6 | - **Date format support**: Multiple date formats including MM/dd/yyyy, yyyy-MM-dd, and dd/MM/yyyy
7 | - **Direct input**: Keyboard-only date entry with input fields for day, month, and year
8 | - **Input validation**: Real-time validation with visual feedback for invalid dates
9 | - **Range support**: Single date selection (default) or date range selection
10 | - **Accessibility**: Full keyboard navigation and screen reader support
11 |
12 | ## Properties [#properties]
13 |
14 | ### `autoFocus` (default: false) [#autofocus-default-false]
15 |
16 | If this property is set to `true`, the component gets the focus automatically when displayed.
17 |
18 | ### `clearable` (default: false) [#clearable-default-false]
19 |
20 | Whether to show a clear button to reset the input
21 |
22 | When enabled, it displays a clear button that allows users to reset the date input back to its initial value. Enter a date in this app and then click the clear button:
23 |
24 | ```xmlui-pg copy display name="Example: clearable" /clearable/
25 | <App>
26 | <DateInput initialValue="05/25/2024" />
27 | <DateInput clearable="true" initialValue="05/25/2024" />
28 | </App>
29 | ```
30 |
31 | ### `clearIcon` [#clearicon]
32 |
33 | Icon name for the clear button
34 |
35 | ```xmlui-pg copy display name="Example: clearIcon" /clearIcon/
36 | <App>
37 | <DateInput initialValue="05/25/2024" clearable="true" clearIcon="trash" />
38 | </App>
39 | ```
40 |
41 | ### `clearToInitialValue` (default: true) [#cleartoinitialvalue-default-true]
42 |
43 | Whether clearing resets to initial value or null
44 |
45 | When `true`, the clear button resets the input to its initial value. When `false`, it clears the input completely.
46 |
47 | ```xmlui-pg copy display name="Example: clearToInitialValue"
48 | <App>
49 | <DateInput clearable="true" clearToInitialValue="true" initialValue="05/25/2024" />
50 | <DateInput clearable="true" clearToInitialValue="false" initialValue="05/25/2024" />
51 | </App>
52 | ```
53 |
54 | ### `dateFormat` (default: "MM/dd/yyyy") [#dateformat-default-mm-dd-yyyy]
55 |
56 | The format of the date displayed in the input field
57 |
58 | Available values: `MM/dd/yyyy` **(default)**, `MM-dd-yyyy`, `yyyy/MM/dd`, `yyyy-MM-dd`, `dd/MM/yyyy`, `dd-MM-yyyy`, `yyyyMMdd`, `MMddyyyy`
59 |
60 | The `dateFormat` prop controls how dates are displayed and entered. Different formats change the order and separators of day, month, and year fields.
61 |
62 | > [!NOTE] Regardless of the dateFormat, the year input field always accepts and displays 4-digit years. When entering a 2-digit year, it will be automatically normalized to a 4-digit year.
63 |
64 | | Format | Description | Example |
65 | | :----- | :---------- | :------ |
66 | | `MM/dd/yyyy` | US format with slashes | 05/25/2024 |
67 | | `MM-dd-yyyy` | US format with dashes | 05-25-2024 |
68 | | `yyyy/MM/dd` | ISO-like format with slashes | 2024/05/25 |
69 | | `yyyy-MM-dd` | ISO format with dashes | 2024-05-25 |
70 | | `dd/MM/yyyy` | European format with slashes | 25/05/2024 |
71 | | `dd-MM-yyyy` | European format with dashes | 25-05-2024 |
72 | | `yyyyMMdd` | Compact format without separators | 20240525 |
73 | | `MMddyyyy` | US compact format | 05252024 |
74 |
75 | ```xmlui-pg copy display name="Example: dateFormat"
76 | <App>
77 | <DateInput dateFormat="MM/dd/yyyy" initialValue="05/25/2024" />
78 | <DateInput dateFormat="yyyy-MM-dd" initialValue="2024-05-25" />
79 | <DateInput dateFormat="dd/MM/yyyy" initialValue="25/05/2024" />
80 | <DateInput dateFormat="yyyyMMdd" initialValue="20240525" />
81 | </App>
82 | ```
83 |
84 | ### `disabledDates` [#disableddates]
85 |
86 | An optional array of dates that are disabled (compatibility with DatePicker, not used in DateInput)
87 |
88 | ### `emptyCharacter` (default: "-") [#emptycharacter-default-]
89 |
90 | Character used to create placeholder text for empty input fields
91 |
92 | Character to use as placeholder for empty date values. If longer than 1 character, uses the first character. Defaults to '-'.
93 |
94 | ```xmlui-pg copy display name="Example: emptyCharacter"
95 | <App>
96 | <DateInput emptyCharacter="." />
97 | <DateInput emptyCharacter="*" />
98 | <DateInput emptyCharacter="abc" />
99 | </App>
100 | ```
101 |
102 | ### `enabled` (default: true) [#enabled-default-true]
103 |
104 | This boolean property value indicates whether the component responds to user events (`true`) or not (`false`).
105 |
106 | ```xmlui-pg copy display name="Example: enabled" height="120px"
107 | <App>
108 | <DateInput enabled="false" initialValue="05/25/2024" />
109 | </App>
110 | ```
111 |
112 | ### `endIcon` [#endicon]
113 |
114 | This property sets an optional icon to appear on the end (right side when the left-to-right direction is set) of the input.
115 |
116 | ### `endText` [#endtext]
117 |
118 | This property sets an optional text to appear on the end (right side when the left-to-right direction is set) of the input.
119 |
120 | ### `gap` [#gap]
121 |
122 | The gap between input elements
123 |
124 | ### `initialValue` [#initialvalue]
125 |
126 | This property sets the component's initial value.
127 |
128 | ```xmlui-pg copy display name="Example: initialValue" height="120px"
129 | <App>
130 | <DateInput initialValue="05/25/2024" />
131 | </App>
132 | ```
133 |
134 | ### `inline` (default: true) [#inline-default-true]
135 |
136 | Whether to display the date input inline (compatibility with DatePicker, always true for DateInput)
137 |
138 | ### `maxValue` [#maxvalue]
139 |
140 | The optional end date of the selectable date range. If not defined, the range allows any future dates.
141 |
142 | ### `minValue` [#minvalue]
143 |
144 | The optional start date of the selectable date range. If not defined, the range allows any dates in the past.
145 |
146 | ### `mode` (default: "single") [#mode-default-single]
147 |
148 | The mode of the date input (single or range)
149 |
150 | Available values: `single` **(default)**, `range`
151 |
152 | Available values:
153 |
154 | | Value | Description |
155 | | --- | --- |
156 | | `single` | Single date selection **(default)** |
157 | | `range` | Date range selection |
158 |
159 | ### `readOnly` (default: false) [#readonly-default-false]
160 |
161 | Set this property to `true` to disallow changing the component value.
162 |
163 | Makes the date input read-only. Users can see the value but cannot modify it.
164 |
165 | ```xmlui-pg copy display name="Example: readOnly" height="120px"
166 | <App>
167 | <DateInput readOnly="true" initialValue="05/25/2024" />
168 | </App>
169 | ```
170 |
171 | ### `required` (default: false) [#required-default-false]
172 |
173 | Whether the input is required
174 |
175 | Marks the date input as required for form validation.
176 |
177 | ```xmlui-pg copy display name="Example: required" height="120px"
178 | <App>
179 | <DateInput required="true" />
180 | </App>
181 | ```
182 |
183 | ### `showWeekNumber` (default: false) [#showweeknumber-default-false]
184 |
185 | Whether to show the week number (compatibility with DatePicker, not used in DateInput)
186 |
187 | ### `startIcon` [#starticon]
188 |
189 | This property sets an optional icon to appear at the start (left side when the left-to-right direction is set) of the input.
190 |
191 | ### `startText` [#starttext]
192 |
193 | This property sets an optional text to appear at the start (left side when the left-to-right direction is set) of the input.
194 |
195 | ### `validationStatus` (default: "none") [#validationstatus-default-none]
196 |
197 | This property allows you to set the validation status of the input component.
198 |
199 | Available values:
200 |
201 | | Value | Description |
202 | | --- | --- |
203 | | `valid` | Visual indicator for an input that is accepted |
204 | | `warning` | Visual indicator for an input that produced a warning |
205 | | `error` | Visual indicator for an input that produced an error |
206 |
207 | | Value | Description |
208 | | :-------- | :---------------------------------------------------- |
209 | | `valid` | Visual indicator for an input that is accepted |
210 | | `warning` | Visual indicator for an input that produced a warning |
211 | | `error` | Visual indicator for an input that produced an error |
212 |
213 | ```xmlui-pg copy display name="Example: validationStatus"
214 | <App>
215 | <DateInput validationStatus="valid" initialValue="05/25/2024" />
216 | <DateInput validationStatus="warning" initialValue="05/25/2024" />
217 | <DateInput validationStatus="error" initialValue="05/25/2024" />
218 | </App>
219 | ```
220 |
221 | ### `weekStartsOn` (default: 0) [#weekstartson-default-0]
222 |
223 | The first day of the week. 0 is Sunday, 1 is Monday, etc. (compatibility with DatePicker, not used in DateInput)
224 |
225 | Available values:
226 |
227 | | Value | Description |
228 | | --- | --- |
229 | | `0` | Sunday **(default)** |
230 | | `1` | Monday |
231 | | `2` | Tuesday |
232 | | `3` | Wednesday |
233 | | `4` | Thursday |
234 | | `5` | Friday |
235 | | `6` | Saturday |
236 |
237 | ## Events [#events]
238 |
239 | ### `didChange` [#didchange]
240 |
241 | This event is triggered when value of DateInput has changed.
242 |
243 | Fired when the date value changes. Receives the new date value as a parameter.
244 |
245 | > [!INFO] The date value changes when the edited input part (day, month, year) loses focus and contains a valid value.
246 |
247 | ```xmlui-pg copy {2} display name="Example: didChange" height="180px"
248 | <App var.selectedDate="No date selected">
249 | <Text value="{selectedDate}" />
250 | <DateInput
251 | dateFormat="yyyy-MM-dd"
252 | initialValue="2024-05-25"
253 | onDidChange="(date) => selectedDate = date" />
254 | </App>
255 | ```
256 |
257 | ### `gotFocus` [#gotfocus]
258 |
259 | This event is triggered when the DateInput has received the focus.
260 |
261 | Fired when the date input receives focus.
262 |
263 | ```xmlui-pg copy {4-5} display name="Example: gotFocus/lostFocus"
264 | <App var.isFocused="{false}">
265 | <Text value="{isFocused
266 | ? 'DateInput focused' : 'DateInput lost focus'}"
267 | />
268 | <DateInput
269 | dateFormat="MM/dd/yyyy"
270 | onGotFocus="isFocused = true"
271 | onLostFocus="isFocused = false"
272 | initialValue="05/25/2024"
273 | />
274 | </App>
275 | ```
276 |
277 | ### `lostFocus` [#lostfocus]
278 |
279 | This event is triggered when the DateInput has lost the focus.
280 |
281 | ## Exposed Methods [#exposed-methods]
282 |
283 | ### `focus` [#focus]
284 |
285 | Focus the DateInput component.
286 |
287 | **Signature**: `focus(): void`
288 |
289 | ### `isoValue` [#isovalue]
290 |
291 | Get the current date value formatted in ISO standard (YYYY-MM-DD) format, suitable for JSON serialization.
292 |
293 | **Signature**: `isoValue(): string | null`
294 |
295 | ### `setValue` [#setvalue]
296 |
297 | This method sets the current value of the DateInput.
298 |
299 | **Signature**: `set value(value: any): void`
300 |
301 | - `value`: The new value to set for the date input.
302 |
303 | ```xmlui-pg copy {3, 9, 12} display name="Example: setValue"
304 | <App>
305 | <HStack>
306 | <Button
307 | label="Set Date to 05/25/2024"
308 | onClick="picker.setValue('05/25/2024')" />
309 | <Button
310 | label="Clear Date"
311 | onClick="picker.setValue('')" />
312 | </HStack>
313 | <DateInput id="picker" />
314 | </App>
315 | ```
316 |
317 | ### `value` [#value]
318 |
319 | You can query the component's value. If no value is set, it will retrieve `undefined`.
320 |
321 | **Signature**: `get value(): any`
322 |
323 | ## Parts [#parts]
324 |
325 | The component has some parts that can be styled through layout properties and theme variables separately:
326 |
327 | - **`clearButton`**: The button to clear the date input.
328 | - **`day`**: The day input field.
329 | - **`month`**: The month input field.
330 | - **`year`**: The year input field.
331 |
332 | ## Styling [#styling]
333 |
334 | ### Theme Variables [#theme-variables]
335 |
336 | | Variable | Default Value (Light) | Default Value (Dark) |
337 | | --- | --- | --- |
338 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput--disabled | *none* | *none* |
339 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput--hover | *none* | *none* |
340 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-default | *none* | *none* |
341 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-default--focus | *none* | *none* |
342 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-default--hover | *none* | *none* |
343 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-error | *none* | *none* |
344 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-error--focus | *none* | *none* |
345 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-error--hover | *none* | *none* |
346 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-success | *none* | *none* |
347 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-success--focus | *none* | *none* |
348 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-success--hover | *none* | *none* |
349 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-warning | *none* | *none* |
350 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-warning--focus | *none* | *none* |
351 | | [backgroundColor](../styles-and-themes/common-units/#color)-DateInput-warning--hover | *none* | *none* |
352 | | [backgroundColor](../styles-and-themes/common-units/#color)-input-DateInput-invalid | rgba(220, 53, 69, 0.15) | rgba(220, 53, 69, 0.15) |
353 | | [border](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
354 | | [borderBottom](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
355 | | [borderBottomColor](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
356 | | [borderBottomStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
357 | | [borderBottomWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
358 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
359 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput--disabled | *none* | *none* |
360 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-default | *none* | *none* |
361 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-default--focus | *none* | *none* |
362 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-default--hover | *none* | *none* |
363 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-error | *none* | *none* |
364 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-error--focus | *none* | *none* |
365 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-error--hover | *none* | *none* |
366 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-success | *none* | *none* |
367 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-success--focus | *none* | *none* |
368 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-success--hover | *none* | *none* |
369 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-warning | *none* | *none* |
370 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-warning--focus | *none* | *none* |
371 | | [borderColor](../styles-and-themes/common-units/#color)-DateInput-warning--hover | *none* | *none* |
372 | | [borderEndEndRadius](../styles-and-themes/common-units/#border-rounding)-DateInput | *none* | *none* |
373 | | [borderEndStartRadius](../styles-and-themes/common-units/#border-rounding)-DateInput | *none* | *none* |
374 | | [borderHorizontal](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
375 | | [borderHorizontalColor](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
376 | | [borderHorizontalStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
377 | | [borderHorizontalWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
378 | | [borderLeft](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
379 | | [color](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
380 | | [borderLeftStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
381 | | [borderLeftWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
382 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-button-DateInput | $borderRadius | $borderRadius |
383 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-DateInput-default | *none* | *none* |
384 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-DateInput-error | *none* | *none* |
385 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-DateInput-success | *none* | *none* |
386 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-DateInput-warning | *none* | *none* |
387 | | [borderRadius](../styles-and-themes/common-units/#border-rounding)-input-DateInput | $borderRadius | $borderRadius |
388 | | [borderRight](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
389 | | [color](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
390 | | [borderRightStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
391 | | [borderRightWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
392 | | [borderStartEndRadius](../styles-and-themes/common-units/#border-rounding)-DateInput | *none* | *none* |
393 | | [borderStartStartRadius](../styles-and-themes/common-units/#border-rounding)-DateInput | *none* | *none* |
394 | | [borderStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
395 | | [borderStyle](../styles-and-themes/common-units/#border-style)-DateInput-default | *none* | *none* |
396 | | [borderStyle](../styles-and-themes/common-units/#border-style)-DateInput-error | *none* | *none* |
397 | | [borderStyle](../styles-and-themes/common-units/#border-style)-DateInput-success | *none* | *none* |
398 | | [borderStyle](../styles-and-themes/common-units/#border-style)-DateInput-warning | *none* | *none* |
399 | | [borderTop](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
400 | | [borderTopColor](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
401 | | [borderTopStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
402 | | [borderTopWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
403 | | [borderHorizontal](../styles-and-themes/common-units/#border)-DateInput | *none* | *none* |
404 | | [borderVerticalColor](../styles-and-themes/common-units/#color)-DateInput | *none* | *none* |
405 | | [borderVerticalStyle](../styles-and-themes/common-units/#border-style)-DateInput | *none* | *none* |
406 | | [borderVerticalWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
407 | | [borderWidth](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
408 | | [borderWidth](../styles-and-themes/common-units/#size)-DateInput-default | *none* | *none* |
409 | | [borderWidth](../styles-and-themes/common-units/#size)-DateInput-error | *none* | *none* |
410 | | [borderWidth](../styles-and-themes/common-units/#size)-DateInput-success | *none* | *none* |
411 | | [borderWidth](../styles-and-themes/common-units/#size)-DateInput-warning | *none* | *none* |
412 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-default | *none* | *none* |
413 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-default--focus | *none* | *none* |
414 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-default--hover | *none* | *none* |
415 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-error | *none* | *none* |
416 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-error--focus | *none* | *none* |
417 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-error--hover | *none* | *none* |
418 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-success | *none* | *none* |
419 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-success--focus | *none* | *none* |
420 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-success--hover | *none* | *none* |
421 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-warning | *none* | *none* |
422 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-warning--focus | *none* | *none* |
423 | | [boxShadow](../styles-and-themes/common-units/#boxShadow)-DateInput-warning--hover | *none* | *none* |
424 | | [color](../styles-and-themes/common-units/#color)-adornment-DateInput-default | *none* | *none* |
425 | | [color](../styles-and-themes/common-units/#color)-adornment-DateInput-error | *none* | *none* |
426 | | [color](../styles-and-themes/common-units/#color)-adornment-DateInput-success | *none* | *none* |
427 | | [color](../styles-and-themes/common-units/#color)-adornment-DateInput-warning | *none* | *none* |
428 | | [color](../styles-and-themes/common-units/#color)-divider-DateInput | $textColor-secondary | $textColor-secondary |
429 | | disabledColor-button-DateInput | $textColor-disabled | $textColor-disabled |
430 | | [fontSize](../styles-and-themes/common-units/#size)-ampm-DateInput | inherit | inherit |
431 | | [fontSize](../styles-and-themes/common-units/#size)-input-DateInput | inherit | inherit |
432 | | [gap](../styles-and-themes/common-units/#size)-adornment-DateInput | *none* | *none* |
433 | | hoverColor-button-DateInput | $color-surface-800 | $color-surface-800 |
434 | | [margin](../styles-and-themes/common-units/#size)-input-DateInput | *none* | *none* |
435 | | [minWidth](../styles-and-themes/common-units/#size)-ampm-DateInput | 2em | 2em |
436 | | [minWidth](../styles-and-themes/common-units/#size)-input-DateInput | 0.54em | 0.54em |
437 | | [opacity](../styles-and-themes/common-units/#opacity)-DateInput--disabled | *none* | *none* |
438 | | [outlineColor](../styles-and-themes/common-units/#color)-button-DateInput--focused | $color-accent-500 | $color-accent-500 |
439 | | [outlineColor](../styles-and-themes/common-units/#color)-DateInput-default--focus | *none* | *none* |
440 | | [outlineColor](../styles-and-themes/common-units/#color)-DateInput-error--focus | *none* | *none* |
441 | | [outlineColor](../styles-and-themes/common-units/#color)-DateInput-success--focus | *none* | *none* |
442 | | [outlineColor](../styles-and-themes/common-units/#color)-DateInput-warning--focus | *none* | *none* |
443 | | [outlineOffset](../styles-and-themes/common-units/#size)-button-DateInput--focused | 2px | 2px |
444 | | [outlineOffset](../styles-and-themes/common-units/#size)-DateInput-default--focus | *none* | *none* |
445 | | [outlineOffset](../styles-and-themes/common-units/#size)-DateInput-error--focus | *none* | *none* |
446 | | [outlineOffset](../styles-and-themes/common-units/#size)-DateInput-success--focus | *none* | *none* |
447 | | [outlineOffset](../styles-and-themes/common-units/#size)-DateInput-warning--focus | *none* | *none* |
448 | | [outlineStyle](../styles-and-themes/common-units/#border)-DateInput-default--focus | *none* | *none* |
449 | | [outlineStyle](../styles-and-themes/common-units/#border)-DateInput-error--focus | *none* | *none* |
450 | | [outlineStyle](../styles-and-themes/common-units/#border)-DateInput-success--focus | *none* | *none* |
451 | | [outlineStyle](../styles-and-themes/common-units/#border)-DateInput-warning--focus | *none* | *none* |
452 | | [outlineWidth](../styles-and-themes/common-units/#size)-button-DateInput--focused | 2px | 2px |
453 | | [outlineWidth](../styles-and-themes/common-units/#size)-DateInput-default--focus | *none* | *none* |
454 | | [outlineWidth](../styles-and-themes/common-units/#size)-DateInput-error--focus | *none* | *none* |
455 | | [outlineWidth](../styles-and-themes/common-units/#size)-DateInput-success--focus | *none* | *none* |
456 | | [outlineWidth](../styles-and-themes/common-units/#size)-DateInput-warning--focus | *none* | *none* |
457 | | [padding](../styles-and-themes/common-units/#size)-button-DateInput | 4px 6px | 4px 6px |
458 | | [padding](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
459 | | [padding](../styles-and-themes/common-units/#size)-input-DateInput | 0 2px | 0 2px |
460 | | [paddingBottom](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
461 | | [paddingHorizontal](../styles-and-themes/common-units/#size)-DateInput | $space-2 | $space-2 |
462 | | [paddingLeft](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
463 | | [paddingRight](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
464 | | [paddingTop](../styles-and-themes/common-units/#size)-DateInput | *none* | *none* |
465 | | [paddingVertical](../styles-and-themes/common-units/#size)-DateInput | $space-2 | $space-2 |
466 | | spacing-divider-DateInput | 1px 0 | 1px 0 |
467 | | [textAlign](../styles-and-themes/common-units/#text-align)-input-DateInput | center | center |
468 | | [textColor](../styles-and-themes/common-units/#color)-DateInput--disabled | *none* | *none* |
469 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-default | *none* | *none* |
470 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-default--focus | *none* | *none* |
471 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-default--hover | *none* | *none* |
472 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-error | *none* | *none* |
473 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-error--focus | *none* | *none* |
474 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-error--hover | *none* | *none* |
475 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-success | *none* | *none* |
476 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-success--focus | *none* | *none* |
477 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-success--hover | *none* | *none* |
478 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-warning | *none* | *none* |
479 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-warning--focus | *none* | *none* |
480 | | [textColor](../styles-and-themes/common-units/#color)-DateInput-warning--hover | *none* | *none* |
481 | | [transition](../styles-and-themes/common-units/#transition)-background-DateInput | *none* | *none* |
482 | | [width](../styles-and-themes/common-units/#size)-input-DateInput | 1.8em | 1.8em |
483 |
```
--------------------------------------------------------------------------------
/xmlui/src/components/App/App.tsx:
--------------------------------------------------------------------------------
```typescript
1 | import styles from "./App.module.scss";
2 | import drawerStyles from "./Sheet.module.scss";
3 |
4 | import { type ComponentDef } from "../../abstractions/ComponentDefs";
5 | import { createComponentRenderer } from "../../components-core/renderers";
6 | import { parseScssVar } from "../../components-core/theming/themeVars";
7 |
8 | import { createMetadata, dComponent } from "../../components/metadata-helpers";
9 | import { appLayoutMd } from "./AppLayoutContext";
10 | import { App, defaultProps } from "./AppNative";
11 | import type { CSSProperties } from "react";
12 | import { useCallback, useEffect, useMemo, useRef, useState, useTransition } from "react";
13 | import type { PageMd } from "../Pages/Pages";
14 | import type { RenderChildFn } from "../../abstractions/RendererDefs";
15 | import { IndexerContext } from "./IndexerContext";
16 | import { createPortal } from "react-dom";
17 | import { useAppContext } from "../../components-core/AppContext";
18 | import { useSearchContextSetIndexing, useSearchContextUpdater } from "./SearchContext";
19 |
20 | // --- Define a structure to represent navigation hierarchy
21 | interface NavHierarchyNode {
22 | type: string;
23 | label: string;
24 | path?: string;
25 | children?: NavHierarchyNode[];
26 | }
27 |
28 | const COMP = "App";
29 |
30 | export const AppMd = createMetadata({
31 | status: "stable",
32 | description:
33 | "The `App` component is the root container that defines your application's overall " +
34 | "structure and layout. It provides a complete UI framework with built-in navigation, " +
35 | "header, footer, and content areas that work together seamlessly.",
36 | props: {
37 | layout: {
38 | description:
39 | `This property sets the layout template of the app. This setting determines the position ` +
40 | `and size of the app parts (such as header, navigation bar, footer, etc.) and the app's ` +
41 | `scroll behavior.`,
42 | availableValues: appLayoutMd,
43 | },
44 | loggedInUser: {
45 | description:
46 | "Stores information about the currently logged-in user. By not defining this property, " +
47 | "you can indicate that no user is logged in.",
48 | valueType: "string",
49 | },
50 | logoTemplate: dComponent("Optional template of the app logo"),
51 | logo: {
52 | description: "Optional logo path",
53 | valueType: "string",
54 | },
55 | "logo-dark": {
56 | description: "Optional logo path in dark tone",
57 | valueType: "string",
58 | },
59 | "logo-light": {
60 | description: "Optional logo path in light tone",
61 | valueType: "string",
62 | },
63 | name: {
64 | description:
65 | "Optional application name (visible in the browser tab). When you do not define " +
66 | "this property, the tab name falls back to the one defined in the app\'s configuration. " +
67 | 'If the name is not configured, "XMLUI App" is displayed in the tab.',
68 | valueType: "string",
69 | },
70 | scrollWholePage: {
71 | description:
72 | `This boolean property specifies whether the whole page should scroll (\`true\`) or just ` +
73 | `the content area (\`false\`). The default value is \`true\`.`,
74 | valueType: "boolean",
75 | defaultValue: defaultProps.scrollWholePage,
76 | },
77 | noScrollbarGutters: {
78 | description:
79 | "This boolean property specifies whether the scrollbar gutters should be hidden.",
80 | valueType: "boolean",
81 | defaultValue: defaultProps.noScrollbarGutters,
82 | },
83 | defaultTone: {
84 | description: 'This property sets the app\'s default tone ("light" or "dark").',
85 | valueType: "string",
86 | defaultValue: defaultProps.defaultTone,
87 | availableValues: ["light", "dark"],
88 | },
89 | defaultTheme: {
90 | description: "This property sets the app's default theme.",
91 | valueType: "string",
92 | defaultValue: defaultProps.defaultTheme,
93 | },
94 | autoDetectTone: {
95 | description:
96 | 'This boolean property enables automatic detection of the system theme preference. ' +
97 | 'When set to true and no defaultTone is specified, the app will automatically use ' +
98 | '"light" or "dark" tone based on the user\'s system theme setting. The app will ' +
99 | 'also respond to changes in the system theme preference.',
100 | valueType: "boolean",
101 | defaultValue: defaultProps.autoDetectTone,
102 | },
103 | },
104 | events: {
105 | ready: {
106 | description: `This event fires when the \`${COMP}\` component finishes rendering on the page.`,
107 | },
108 | messageReceived: {
109 | description: `This event fires when the \`${COMP}\` component receives a message from another window or iframe via the window.postMessage API.`,
110 | },
111 | },
112 | themeVars: { ...parseScssVar(styles.themeVars), ...parseScssVar(drawerStyles.themeVars) },
113 | limitThemeVarsToComponent: true,
114 | themeVarDescriptions: {
115 | "maxWidth-content-App":
116 | "This theme variable defines the maximum width of the main content. If the main " +
117 | "content is broader, the engine adds margins to keep the expected maximum size.",
118 | "boxShadow‑header‑App": "This theme variable sets the shadow of the app's header section.",
119 | "boxShadow‑navPanel‑App":
120 | "This theme variable sets the shadow of the app's navigation panel section " +
121 | "(visible only in vertical layouts).",
122 | "width‑navPanel‑App":
123 | "This theme variable sets the width of the navigation panel when the app is displayed " +
124 | "with one of the vertical layouts.",
125 | },
126 | defaultThemeVars: {
127 | "maxWidth-Drawer": "100%",
128 | [`width-navPanel-${COMP}`]: "$space-64",
129 | [`backgroundColor-navPanel-${COMP}`]: "$backgroundColor",
130 | [`maxWidth-content-${COMP}`]: "$maxWidth-content",
131 | [`boxShadow-header-${COMP}`]: "none",
132 | [`boxShadow-navPanel-${COMP}`]: "$boxShadow-spread",
133 | [`scroll-padding-block-Pages`]: "$space-4",
134 | [`backgroundColor-content-App`]: "$backgroundColor",
135 | light: {
136 | // --- No light-specific theme vars
137 | },
138 | dark: {
139 | // --- No dark-specific theme vars
140 | },
141 | },
142 | });
143 |
144 |
145 | function AppNode({ node, extractValue, renderChild, className, lookupEventHandler, registerComponentApi }) {
146 | // --- Use ref to track if we've already processed the navigation to avoid duplicates in strict mode
147 | const processedNavRef = useRef(false);
148 |
149 | // --- Memoize the layout type to avoid unnecessary re-extraction
150 | const layoutType = useMemo(
151 | () => extractValue(node.props.layout),
152 | [node.props.layout, extractValue],
153 | );
154 |
155 | // --- Memoize helper functions that are used in multiple places
156 |
157 | // --- Parse a string into hierarchy labels, handling escaped pipe characters
158 | const parseHierarchyLabels = useMemo(() => {
159 | // Cache to hold previously computed results
160 | const cache = new Map<string, string[]>();
161 |
162 | return (labelText: string): string[] => {
163 | // Return cached result if we've seen this input before
164 | if (cache.has(labelText)) {
165 | return cache.get(labelText)!;
166 | }
167 |
168 | const result: string[] = [];
169 | let currentLabel = "";
170 | let escaped = false;
171 |
172 | for (let i = 0; i < labelText.length; i++) {
173 | const char = labelText[i];
174 |
175 | if (escaped) {
176 | // --- If this character was escaped, just add it literally
177 | currentLabel += char;
178 | escaped = false;
179 | } else if (char === "\\") {
180 | // --- Start of an escape sequence
181 | escaped = true;
182 | } else if (char === "|") {
183 | // --- Unescaped pipe indicates hierarchy separator
184 | result.push(currentLabel.trim());
185 | currentLabel = "";
186 | } else {
187 | // --- Regular character
188 | currentLabel += char;
189 | }
190 | }
191 |
192 | // --- Don't forget to add the last segment
193 | if (currentLabel.length > 0) {
194 | result.push(currentLabel.trim());
195 | }
196 |
197 | // Cache the result
198 | cache.set(labelText, result);
199 |
200 | return result;
201 | };
202 | }, []);
203 |
204 | // --- Helper function to check if a label exists in the navigation hierarchy
205 | const labelExistsInHierarchy = useMemo(() => {
206 | // Cache for previously checked labels within a hierarchy
207 | const cache = new Map<string, boolean>();
208 |
209 | return (searchLabel: string, hierarchy: any[]): boolean => {
210 | // Create a cache key (could be improved with a better serialization of hierarchy)
211 | const cacheKey = searchLabel + "_" + hierarchy.length;
212 |
213 | if (cache.has(cacheKey)) {
214 | return cache.get(cacheKey)!;
215 | }
216 |
217 | const result = hierarchy.some((node) => {
218 | if (node.label === searchLabel) {
219 | return true;
220 | }
221 |
222 | if (node.children && node.children.length > 0) {
223 | return labelExistsInHierarchy(searchLabel, node.children);
224 | }
225 |
226 | return false;
227 | });
228 |
229 | cache.set(cacheKey, result);
230 | return result;
231 | };
232 | }, []);
233 |
234 | // --- Helper function to find or create NavGroups in the hierarchy
235 | const findOrCreateNavGroup = useMemo(() => {
236 | return (navItems: any[], groupLabel: string): any => {
237 | // --- Check if a NavGroup with this label already exists
238 | const existingGroup = navItems.find(
239 | (item) => item.type === "NavGroup" && item.props?.label === groupLabel,
240 | );
241 |
242 | if (existingGroup) {
243 | return existingGroup;
244 | }
245 |
246 | // --- Create a new NavGroup and add it to the array
247 | const newGroup = {
248 | type: "NavGroup",
249 | props: {
250 | label: groupLabel,
251 | },
252 | children: [],
253 | };
254 |
255 | navItems.push(newGroup);
256 | return newGroup;
257 | };
258 | }, []);
259 |
260 | const { AppHeader, Footer, NavPanel, Pages, restChildren } = useMemo(() => {
261 | let AppHeader: ComponentDef;
262 | let Footer: ComponentDef;
263 | let NavPanel: ComponentDef;
264 | let Pages: ComponentDef;
265 | const restChildren: any[] = [];
266 | node.children?.forEach((rootChild) => {
267 | let transformedChild = { ...rootChild };
268 | if (rootChild.type === "Theme") {
269 | transformedChild.children = rootChild.children?.filter((child) => {
270 | if (child.type === "AppHeader") {
271 | AppHeader = {
272 | ...rootChild,
273 | children: [child],
274 | };
275 | return false;
276 | } else if (child.type === "Footer") {
277 | Footer = {
278 | ...rootChild,
279 | children: [child],
280 | };
281 | return false;
282 | } else if (child.type === "NavPanel") {
283 | NavPanel = {
284 | ...rootChild,
285 | children: [child],
286 | };
287 | return false;
288 | }
289 | return true;
290 | });
291 | if (!transformedChild.children.length) {
292 | transformedChild = null;
293 | }
294 | }
295 | if (rootChild.type === "AppHeader") {
296 | AppHeader = rootChild;
297 | } else if (rootChild.type === "Footer") {
298 | Footer = rootChild;
299 | } else if (rootChild.type === "NavPanel") {
300 | NavPanel = rootChild;
301 | } else if (rootChild.type === "Pages") {
302 | Pages = rootChild;
303 | restChildren.push(transformedChild);
304 | } else if (transformedChild !== null) {
305 | restChildren.push(transformedChild);
306 | }
307 | });
308 |
309 | // --- Check if there is any extra NavPanel in Pages
310 | const extraNavs = extractNavPanelFromPages(
311 | Pages,
312 | NavPanel,
313 | processedNavRef,
314 | extractValue,
315 | parseHierarchyLabels,
316 | labelExistsInHierarchy,
317 | findOrCreateNavGroup,
318 | );
319 |
320 | // --- If we found extra navigation items
321 | if (extraNavs?.length) {
322 | if (NavPanel) {
323 | // --- Create a new NavPanel with combined children instead of mutating the existing one
324 | NavPanel = {
325 | ...NavPanel,
326 | children: NavPanel.children ? [...NavPanel.children, ...extraNavs] : extraNavs,
327 | };
328 | } else {
329 | // --- Create a new NavPanel component definition if none exists
330 | NavPanel = {
331 | type: "NavPanel",
332 | props: {},
333 | children: extraNavs,
334 | };
335 | }
336 | }
337 |
338 | return {
339 | AppHeader,
340 | Footer,
341 | NavPanel,
342 | Pages,
343 | restChildren,
344 | };
345 | }, [
346 | node.children,
347 | extractValue,
348 | parseHierarchyLabels,
349 | labelExistsInHierarchy,
350 | findOrCreateNavGroup,
351 | ]);
352 |
353 | const applyDefaultContentPadding= !Pages;
354 |
355 | // --- Memoize all app props to prevent unnecessary re-renders
356 | const appProps = useMemo(
357 | () => ({
358 | scrollWholePage: extractValue.asOptionalBoolean(node.props.scrollWholePage, true),
359 | noScrollbarGutters: extractValue.asOptionalBoolean(node.props.noScrollbarGutters, false),
360 | className,
361 | layout: layoutType,
362 | loggedInUser: extractValue(node.props.loggedInUser),
363 | onReady: lookupEventHandler("ready"),
364 | onMessageReceived: lookupEventHandler("messageReceived"),
365 | name: extractValue(node.props.name),
366 | logo: extractValue(node.props.logo),
367 | logoDark: extractValue(node.props["logo-dark"]),
368 | logoLight: extractValue(node.props["logo-light"]),
369 | defaultTone: extractValue(node.props.defaultTone),
370 | defaultTheme: extractValue(node.props.defaultTheme),
371 | autoDetectTone: extractValue.asOptionalBoolean(node.props.autoDetectTone, false),
372 | applyDefaultContentPadding
373 | }),
374 | [
375 | extractValue,
376 | layoutType,
377 | lookupEventHandler,
378 | node.props.loggedInUser,
379 | node.props.noScrollbarGutters,
380 | node.props.scrollWholePage,
381 | node.props.name,
382 | node.props.logo,
383 | node.props["logo-dark"],
384 | node.props["logo-light"],
385 | node.props.defaultTone,
386 | node.props.defaultTheme,
387 | node.props.autoDetectTone,
388 | className,
389 | applyDefaultContentPadding
390 | ],
391 | );
392 |
393 | // Memoize the rendered children to prevent unnecessary re-renders
394 | const renderedHeader = useMemo(() => renderChild(AppHeader), [AppHeader, renderChild]);
395 | const renderedFooter = useMemo(() => renderChild(Footer), [Footer, renderChild]);
396 | const renderedNavPanel = useMemo(() => renderChild(NavPanel), [NavPanel, renderChild]);
397 | const renderedContent = useMemo(() => renderChild(restChildren), [restChildren, renderChild]);
398 |
399 | return (
400 | <App
401 | {...appProps}
402 | header={renderedHeader}
403 | footer={renderedFooter}
404 | navPanel={renderedNavPanel}
405 | navPanelDef={NavPanel}
406 | logoContentDef={node.props.logoTemplate}
407 | renderChild={renderChild}
408 | registerComponentApi={registerComponentApi}
409 | >
410 | {renderedContent}
411 | <SearchIndexCollector Pages={Pages} renderChild={renderChild} />
412 | </App>
413 | );
414 | }
415 |
416 | const HIDDEN_STYLE: CSSProperties = {
417 | position: "absolute",
418 | top: "-9999px",
419 | display: "none",
420 | };
421 |
422 | const indexerContextValue = {
423 | indexing: true,
424 | };
425 |
426 | function SearchIndexCollector({ Pages, renderChild }) {
427 | const appContext = useAppContext();
428 | const setIndexing = useSearchContextSetIndexing();
429 |
430 | const [isClient, setIsClient] = useState(false);
431 | useEffect(() => {
432 | setIsClient(true); // Ensure document.body is available
433 |
434 | return () => {
435 | setIndexing(false);
436 | };
437 | }, [setIndexing]);
438 |
439 | // 1. Memoize the list of pages to be indexed
440 | const pagesToIndex = useMemo(() => {
441 | return (
442 | Pages?.children?.filter(
443 | (child) =>
444 | child.type === "Page" && // Ensure 'Page' matches your actual component type name
445 | child.props?.url && // Ensure URL exists
446 | !child.props.url.includes("*") &&
447 | !child.props.url.includes(":"),
448 | ) || []
449 | );
450 | }, [Pages?.children]);
451 |
452 | const [currentIndex, setCurrentIndex] = useState(0);
453 | const [isDoneIndexing, setIsDoneIndexing] = useState(false);
454 | const [, startTransitionParent] = useTransition(); // Transition for parent updates
455 |
456 | const handlePageIndexed = useCallback(() => {
457 | startTransitionParent(() => {
458 | // Transition the update to the next page
459 | setCurrentIndex((prevIndex) => {
460 | const nextIndex = prevIndex + 1;
461 | if (nextIndex >= pagesToIndex.length) {
462 | // console.log("All pages indexed.");
463 | setIsDoneIndexing(true); // All pages processed
464 | }
465 | return nextIndex;
466 | });
467 | });
468 | }, [pagesToIndex.length]); // Recreate if the total number of pages changes
469 |
470 | if (!appContext.appGlobals?.searchIndexEnabled || isDoneIndexing || !isClient) {
471 | return null;
472 | }
473 |
474 | const currentPageToProcess = pagesToIndex[currentIndex];
475 |
476 | if (!currentPageToProcess) {
477 | // This can happen if pagesToIndex is empty or currentIndex went out of bounds unexpectedly.
478 | // Setting isDoneIndexing if pagesToIndex is empty initially.
479 | if (pagesToIndex.length === 0 && currentIndex === 0 && !isDoneIndexing) {
480 | setIsDoneIndexing(true);
481 | }
482 | return null;
483 | }
484 |
485 | return (
486 | <IndexerContext.Provider value={indexerContextValue}>
487 | {createPortal(
488 | <div style={HIDDEN_STYLE} aria-hidden="true">
489 | {/* Render only one PageIndexer at a time */}
490 | <PageIndexer
491 | Page={currentPageToProcess}
492 | renderChild={renderChild}
493 | onIndexed={handlePageIndexed}
494 | key={currentPageToProcess.props?.url || currentIndex} // Key ensures re-mount
495 | />
496 | </div>,
497 | document.body,
498 | )}
499 | </IndexerContext.Provider>
500 | );
501 | }
502 |
503 | function PageIndexer({
504 | Page,
505 | renderChild,
506 | onIndexed,
507 | }: {
508 | Page: ComponentDef<typeof PageMd>; // Use the defined PageMdProps
509 | renderChild: RenderChildFn;
510 | onIndexed: () => void;
511 | }) {
512 | const contentRef = useRef<HTMLDivElement>(null);
513 | const pageUrl = Page.props?.url || "";
514 | const navLabel = Page.props?.navLabel || "";
515 | const searchContextUpdater = useSearchContextUpdater();
516 |
517 | const [isContentRendered, setIsContentRendered] = useState(false);
518 | const [isCollected, setIsCollected] = useState(false);
519 | const [isProcessing, startTransition] = useTransition();
520 |
521 | // Effect 1: Schedule the rendering of the Page's children (low priority)
522 | useEffect(() => {
523 | // console.log(`PageIndexer (${pageUrl}): Scheduling content render.`);
524 | startTransition(() => {
525 | setIsContentRendered(true); // This will trigger rendering of Page.children
526 | });
527 | }, [pageUrl]); // Re-run if the Page prop itself changes identity (due to key in parent)
528 |
529 | // Effect 2: Extract content once Page.children is rendered and ref is available (low priority)
530 | useEffect(() => {
531 | if (isContentRendered && contentRef.current && !isCollected && !isProcessing) {
532 | // console.log(`PageIndexer (${pageUrl}): Content rendered, scheduling extraction.`);
533 | startTransition(() => {
534 | // console.log(`PageIndexer (${pageUrl}): Starting extraction...`);
535 | const currentContent = contentRef.current; // Capture ref value
536 | if (!currentContent) return;
537 |
538 | const clone = currentContent.cloneNode(true) as HTMLDivElement;
539 | const elementsToRemove = clone.querySelectorAll("style, script");
540 | elementsToRemove.forEach((el) => el.remove());
541 | const titleElement = clone.querySelector("h1");
542 | const title = titleElement
543 | ? titleElement.innerText
544 | : navLabel || pageUrl.split("/").pop() || pageUrl;
545 | titleElement?.remove(); // Remove title element from clone to avoid duplication
546 | const textContent = (clone.textContent || "").trim().replace(/\s+/g, " ");
547 |
548 | const entry = {
549 | title: title,
550 | content: textContent,
551 | path: pageUrl,
552 | };
553 |
554 | searchContextUpdater(entry);
555 | // console.log(`PageIndexer (${pageUrl}): Extraction complete, signaling parent.`);
556 | onIndexed(); // Signal completion to parent
557 | setIsCollected(true); // Mark as collected
558 | });
559 | }
560 | }, [
561 | isContentRendered,
562 | pageUrl,
563 | searchContextUpdater,
564 | onIndexed,
565 | isCollected,
566 | isProcessing,
567 | navLabel,
568 | ]); // Ensure all dependencies are listed
569 |
570 | // If this PageIndexer instance's work is done, or content not yet rendered, render nothing.
571 | // The parent (SearchIndexCollector) will unmount this and mount the next one.
572 | if (isCollected || !isContentRendered) {
573 | // console.log(`PageIndexer (${pageUrl}): Null render (isCollected: ${isCollected}, isContentRendered: ${isContentRendered})`);
574 | return null;
575 | }
576 |
577 | // This part renders when isContentRendered is true and isCollected is false.
578 | // The content needs to be in the DOM for contentRef.current to be populated.
579 | // console.log(`PageIndexer (${pageUrl}): Rendering content for ref population.`);
580 | return <div ref={contentRef}>{renderChild(Page.children)}</div>;
581 | }
582 |
583 | export const appRenderer = createComponentRenderer(
584 | COMP,
585 | AppMd,
586 | ({ node, extractValue, renderChild, className, lookupEventHandler, registerComponentApi }) => {
587 | return (
588 | <AppNode
589 | node={node}
590 | renderChild={renderChild}
591 | extractValue={extractValue}
592 | className={className}
593 | lookupEventHandler={lookupEventHandler}
594 | registerComponentApi={registerComponentApi}
595 | />
596 | );
597 | },
598 | );
599 |
600 | // --- Process the entire navigation tree recursively and build hierarchy
601 | function processNavItems(
602 | items: ComponentDef[],
603 | parentHierarchy: NavHierarchyNode[],
604 | extractValue: (value: any) => any,
605 | ) {
606 | items.forEach((navItem) => {
607 | // --- Process NavLink items
608 | if (navItem.type === "NavLink") {
609 | let itemLabel = navItem.props?.label;
610 | let itemPath = navItem.props?.to;
611 |
612 | if (!itemLabel) {
613 | if (navItem.children?.length === 1 && navItem.children[0].type === "TextNode") {
614 | itemLabel = navItem.children[0].props.value;
615 | }
616 | }
617 |
618 | if (itemLabel) {
619 | const labelValue = extractValue(itemLabel);
620 |
621 | // --- Add to hierarchy
622 | parentHierarchy.push({
623 | type: "NavLink",
624 | label: labelValue,
625 | path: itemPath ? extractValue(itemPath) : undefined,
626 | });
627 | }
628 | }
629 | // --- Process NavGroup items (which may contain nested NavLink or NavGroup items)
630 | else if (navItem.type === "NavGroup") {
631 | let groupLabel = navItem.props?.label;
632 |
633 | if (groupLabel) {
634 | const labelValue = extractValue(groupLabel);
635 |
636 | // --- Create group node
637 | const groupNode: NavHierarchyNode = {
638 | type: "NavGroup",
639 | label: labelValue,
640 | children: [],
641 | };
642 |
643 | // --- Add to parent hierarchy
644 | parentHierarchy.push(groupNode);
645 |
646 | // --- Recursively process children of the NavGroup
647 | if (navItem.children && navItem.children.length > 0) {
648 | processNavItems(navItem.children, groupNode.children, extractValue);
649 | }
650 | } else if (navItem.children && navItem.children.length > 0) {
651 | // --- If no label but has children, still process them under parent
652 | processNavItems(navItem.children, parentHierarchy, extractValue);
653 | }
654 | }
655 | });
656 | }
657 |
658 | // --- Extract navigation panel items from Pages component
659 | function extractNavPanelFromPages(
660 | Pages: ComponentDef,
661 | NavPanel: ComponentDef | undefined,
662 | processedNavRef: React.MutableRefObject<boolean>,
663 | extractValue: (value: any) => any,
664 | parseHierarchyLabels: (labelText: string) => string[],
665 | labelExistsInHierarchy: (searchLabel: string, hierarchy: NavHierarchyNode[]) => boolean,
666 | findOrCreateNavGroup: (navItems: ComponentDef[], groupLabel: string) => ComponentDef,
667 | ): ComponentDef[] | null {
668 | // --- Skip extraction if we've already processed this navigation structure
669 | // --- This prevents duplicate items when React renders twice in strict mode
670 | if (!Pages || processedNavRef.current) return null;
671 |
672 | // --- Mark as processed
673 | processedNavRef.current = true;
674 |
675 | const extraNavs: ComponentDef[] = [];
676 |
677 | // --- Root of navigation hierarchy
678 | const navigationHierarchy: NavHierarchyNode[] = [];
679 |
680 | // --- Start processing the navigation tree if NavPanel exists
681 | if (NavPanel?.children) {
682 | processNavItems(NavPanel.children, navigationHierarchy, extractValue);
683 | }
684 |
685 | // --- Process Pages to create hierarchical navigation structure
686 | Pages.children?.forEach((page) => {
687 | if (page.type === "Page" && page.props.navLabel) {
688 | const label = extractValue(page.props.navLabel);
689 | const url = extractValue(page.props.url);
690 |
691 | // --- Parse hierarchy labels separated by unescaped pipe characters
692 | const hierarchyLabels = parseHierarchyLabels(label);
693 |
694 | // --- Skip if we have no labels
695 | if (hierarchyLabels.length === 0) {
696 | return;
697 | }
698 |
699 | // --- For a single level, just add a NavLink directly
700 | if (hierarchyLabels.length === 1) {
701 | // --- Check if this exact NavLink already exists in the navigation hierarchy
702 | if (!labelExistsInHierarchy(hierarchyLabels[0], navigationHierarchy)) {
703 | extraNavs.push({
704 | type: "NavLink",
705 | props: {
706 | label: hierarchyLabels[0],
707 | to: url,
708 | },
709 | });
710 | }
711 | return;
712 | }
713 |
714 | // --- For multi-level hierarchies, create NavGroups and a final NavLink
715 | let currentLevel = extraNavs;
716 |
717 | // --- Create NavGroups for all levels except the last one
718 | for (let i = 0; i < hierarchyLabels.length - 1; i++) {
719 | const groupLabel = hierarchyLabels[i];
720 | const navGroup = findOrCreateNavGroup(currentLevel, groupLabel);
721 |
722 | // --- Initialize children array if it doesn't exist
723 | if (!navGroup.children) {
724 | navGroup.children = [];
725 | }
726 |
727 | // --- Move to the next level
728 | currentLevel = navGroup.children;
729 | }
730 |
731 | // --- Add the leaf NavLink to the deepest NavGroup
732 | const leafLabel = hierarchyLabels[hierarchyLabels.length - 1];
733 |
734 | // --- Check if this NavLink already exists at this level
735 | const existingNavLink = currentLevel.find(
736 | (item) => item.type === "NavLink" && item.props?.label === leafLabel,
737 | );
738 |
739 | if (!existingNavLink) {
740 | currentLevel.push({
741 | type: "NavLink",
742 | props: {
743 | label: leafLabel,
744 | to: url,
745 | },
746 | });
747 | }
748 | }
749 | });
750 |
751 | return extraNavs;
752 | }
753 |
```
--------------------------------------------------------------------------------
/xmlui/dev-docs/build-system.md:
--------------------------------------------------------------------------------
```markdown
1 | # XMLUI Build System
2 |
3 | This document explains XMLUI's build system architecture, CLI tools, and build configurations for application deployment and extension development.
4 |
5 | > **Note:** For building the XMLUI framework package itself, see [Building the XMLUI Core Package](./build-xmlui.md).
6 |
7 | ## Table of Contents
8 |
9 | 1. [Overview](#overview)
10 | 2. [CLI Commands](#cli-commands)
11 | - [xmlui start](#xmlui-start)
12 | - [xmlui build](#xmlui-build)
13 | - [xmlui preview](#xmlui-preview)
14 | - [xmlui build-lib](#xmlui-build-lib)
15 | - [xmlui zip-dist](#xmlui-zip-dist)
16 | 3. [Build Modes](#build-modes)
17 | 4. [Vite Plugin System](#vite-plugin-system)
18 | 5. [Build Configurations](#build-configurations)
19 | 6. [Building XMLUI Extensions](#building-xmlui-extensions)
20 | 7. [Package Structure](#package-structure)
21 | 8. [Development Workflow](#development-workflow)
22 |
23 | ## Overview
24 |
25 | XMLUI uses a multi-mode build system built on **Vite** that supports:
26 |
27 | - **Development server** with hot module reloading for rapid app development
28 | - **Production builds** for XMLUI applications with optimized assets
29 | - **Extension builds** for creating reusable component libraries
30 | - **Metadata extraction** for documentation and language server support
31 |
32 | The build system is orchestrated through the `xmlui` CLI command, which provides a unified interface for all build operations.
33 |
34 | ## CLI Commands
35 |
36 | The XMLUI CLI is installed via the `bin/bootstrap.js` entry point and provides commands for development, building, and deployment.
37 |
38 | ### xmlui start
39 |
40 | Starts a Vite development server with hot module reloading for rapid application development.
41 |
42 | **Usage:**
43 |
44 | ```bash
45 | xmlui start [options]
46 | ```
47 |
48 | **Options:**
49 |
50 | - `--port <number>` - Server port (default: Vite's default port)
51 | - `--withMock [boolean]` - Enable MSW API mocking (default: true)
52 | - `--proxy <pattern->target>` - Proxy API requests (e.g., `/api->http://localhost:3000`)
53 |
54 | **Examples:**
55 |
56 | ```bash
57 | # Start dev server with default settings
58 | xmlui start
59 |
60 | # Start on port 3000 without mocking
61 | xmlui start --port 3000 --withMock=false
62 |
63 | # Start with API proxy
64 | xmlui start --proxy /api->http://localhost:8080
65 | ```
66 |
67 | **Behavior:**
68 |
69 | - Enables full build mode (`VITE_BUILD_MODE=ALL`) with all components included
70 | - Automatically enables MSW for API interception unless disabled
71 | - Provides instant feedback through HMR when source files change
72 | - Compiles `.xmlui` and `.xmlui.xs` files on-demand via vite-xmlui-plugin
73 |
74 | ### xmlui build
75 |
76 | Builds an XMLUI application for production deployment with optimized assets.
77 |
78 | **Usage:**
79 |
80 | ```bash
81 | xmlui build [options]
82 | ```
83 |
84 | **Options:**
85 |
86 | - `--buildMode <mode>` - Build mode: `CONFIG_ONLY`, `INLINE_ALL`, or `ALL` (default: `CONFIG_ONLY` in dev, auto in prod)
87 | - `--flatDist [boolean]` - Flatten dist directory structure for simple hosting (default: false in dev, true in prod)
88 | - `--withMock [boolean]` - Include MSW API mocking in build (default: true in dev, false in prod)
89 | - `--withHostingMetaFiles [boolean]` - Include hosting metadata files (serve.json, web.config) (default: false in dev, false in prod)
90 | - `--withRelativeRoot [boolean]` - Use relative paths for root references (default: false in dev, true in prod)
91 | - `--prod` - Shorthand for production-ready settings
92 |
93 | **Build Modes:**
94 |
95 | | Mode | Description | Use Case |
96 | | ------------- | ------------------------------------------------------- | ---------------------------------------- |
97 | | `CONFIG_ONLY` | Bundles only configuration; loads components at runtime | Development and dynamic apps |
98 | | `INLINE_ALL` | Bundles entire app including all components | Production with minimal runtime overhead |
99 | | `ALL` | Full build with both inline and runtime loading support | Maximum flexibility |
100 |
101 | **Examples:**
102 |
103 | ```bash
104 | # Development build
105 | xmlui build
106 |
107 | # Production build with defaults
108 | xmlui build --prod
109 |
110 | # Production build with specific settings
111 | xmlui build --buildMode=INLINE_ALL --flatDist --withHostingMetaFiles
112 |
113 | # Test deployment build with mocking
114 | xmlui build --buildMode=INLINE_ALL --withMock --withHostingMetaFiles
115 | ```
116 |
117 | **Output Structure:**
118 |
119 | _Standard (flatDist=false):_
120 |
121 | ```
122 | dist/
123 | ├── index.html
124 | ├── assets/
125 | │ ├── index-[hash].js
126 | │ └── index-[hash].css
127 | └── resources/
128 | └── (resource files)
129 | ```
130 |
131 | _Flattened (flatDist=true):_
132 |
133 | ```
134 | dist/
135 | ├── index.html
136 | ├── ui_assets_index-[hash].js
137 | ├── ui_assets_index-[hash].css
138 | ├── ui_resources_logo.png
139 | └── (all files at root with ui_ prefix)
140 | ```
141 |
142 | ### xmlui preview
143 |
144 | Serves a production build locally for testing before deployment.
145 |
146 | **Usage:**
147 |
148 | ```bash
149 | xmlui preview [options]
150 | ```
151 |
152 | **Options:**
153 |
154 | - `--proxy <pattern->target>` - Proxy API requests during preview
155 |
156 | **Example:**
157 |
158 | ```bash
159 | # Build and preview
160 | xmlui build --prod
161 | xmlui preview
162 |
163 | # Preview with API proxy
164 | xmlui preview --proxy /api->http://localhost:8080
165 | ```
166 |
167 | ### xmlui build-lib
168 |
169 | Builds the XMLUI framework itself as a distributable npm package. This command is used during XMLUI framework development, not for application builds.
170 |
171 | **Usage:**
172 |
173 | ```bash
174 | xmlui build-lib [options]
175 | ```
176 |
177 | **Options:**
178 |
179 | - `--watch [boolean]` - Watch mode for continuous rebuilds during development (default: false)
180 | - `--mode <mode>` - Build mode: `lib`, `standalone`, or `metadata`
181 |
182 | **Examples:**
183 |
184 | ```bash
185 | # Build library for npm distribution
186 | npm run build:xmlui
187 |
188 | # Build standalone bundle
189 | npm run build:xmlui-standalone
190 |
191 | # Build with watch mode during development
192 | xmlui build-lib --watch
193 | ```
194 |
195 | ### xmlui zip-dist
196 |
197 | Creates a ZIP archive of the dist directory for deployment.
198 |
199 | **Usage:**
200 |
201 | ```bash
202 | xmlui zip-dist [options]
203 | ```
204 |
205 | **Options:**
206 |
207 | - `--source <path>` - Source directory to zip (default: `dist`)
208 | - `--target <filename>` - Output ZIP filename (default: `ui.zip`)
209 |
210 | **Example:**
211 |
212 | ```bash
213 | xmlui build --prod
214 | xmlui zip-dist --target production.zip
215 | ```
216 |
217 | ## Build Modes
218 |
219 | XMLUI applications can be built in three distinct modes that control how components and configurations are bundled:
220 |
221 | ### CONFIG_ONLY Mode
222 |
223 | **Characteristics:**
224 |
225 | - Only configuration and entry point are bundled
226 | - Components loaded at runtime from source files
227 | - Smallest bundle size
228 | - Requires buildless component discovery at runtime
229 |
230 | **Use Cases:**
231 |
232 | - Development environments
233 | - Applications with frequently changing components
234 | - Scenarios where component hot-swapping is needed
235 |
236 | ### INLINE_ALL Mode
237 |
238 | **Characteristics:**
239 |
240 | - All components pre-compiled and bundled
241 | - No runtime parsing or component discovery
242 | - Fastest startup time
243 | - Larger initial bundle size
244 |
245 | **Use Cases:**
246 |
247 | - Production deployments
248 | - Performance-critical applications
249 | - Environments with restricted runtime file access
250 |
251 | ### ALL Mode
252 |
253 | **Characteristics:**
254 |
255 | - Hybrid approach with both bundled and runtime loading
256 | - Maximum flexibility
257 | - Balanced bundle size and performance
258 |
259 | **Use Cases:**
260 |
261 | - Complex applications with both static and dynamic components
262 | - Testing and staging environments
263 |
264 | ## Vite Plugin System
265 |
266 | The `vite-xmlui-plugin` transforms XMLUI source files during the build process.
267 |
268 | ### Plugin Responsibilities
269 |
270 | 1. **Transform .xmlui files** - Parses markup into component definitions
271 | 2. **Transform .xmlui.xs files** - Processes code-behind scripts
272 | 3. **Transform .xmlui.xm files** - Processes module scripts
273 | 4. **Error handling** - Converts parse errors into error components
274 | 5. **Code generation** - Produces ESM modules for Vite bundling
275 |
276 | ### Transformation Pipeline
277 |
278 | ```
279 | .xmlui file
280 | ↓
281 | xmlUiMarkupToComponent()
282 | ↓
283 | ComponentDef object
284 | ↓
285 | dataToEsm()
286 | ↓
287 | JavaScript module
288 | ```
289 |
290 | ```
291 | .xmlui.xs file
292 | ↓
293 | Parser.parseStatements()
294 | ↓
295 | collectCodeBehindFromSource()
296 | ↓
297 | Code-behind definition
298 | ↓
299 | dataToEsm()
300 | ↓
301 | JavaScript module
302 | ```
303 |
304 | ### Plugin Configuration
305 |
306 | The plugin is configured in `vite.config.ts`:
307 |
308 | ```typescript
309 | import ViteXmlui from "./bin/vite-xmlui-plugin";
310 |
311 | export default {
312 | plugins: [
313 | ViteXmlui({
314 | // Plugin options (currently none defined)
315 | }),
316 | ],
317 | };
318 | ```
319 |
320 | ## Build Configurations
321 |
322 | XMLUI uses Vite with mode-specific configurations for different build targets.
323 |
324 | ### Library Build (lib)
325 |
326 | **Purpose:** Build XMLUI framework for npm distribution
327 |
328 | **Entry Points:**
329 |
330 | - `xmlui` - Main framework export
331 | - `xmlui-parser` - Parser utilities
332 | - `language-server` - Node.js language server
333 | - `language-server-web-worker` - Browser-based language server
334 | - `syntax-monaco` - Monaco editor syntax support
335 | - `syntax-textmate` - TextMate grammar support
336 |
337 | **Output Format:** ES modules
338 |
339 | **Key Features:**
340 |
341 | - TypeScript declarations generated via `vite-plugin-dts`
342 | - CSS injection via `vite-plugin-lib-inject-css`
343 | - SCSS source files copied to `dist/lib/scss/`
344 | - React and SVG support
345 | - Rollup type bundling for optimized .d.ts files
346 |
347 | **NPM Package Exports:**
348 |
349 | ```json
350 | {
351 | ".": "./dist/lib/xmlui.js",
352 | "./parser": "./dist/lib/xmlui-parser.js",
353 | "./language-server": "./dist/lib/language-server.js",
354 | "./vite-xmlui-plugin": "./dist/scripts/bin/vite-xmlui-plugin.js",
355 | "./*.css": "./dist/lib/*.css",
356 | "./index.scss": "./dist/lib/scss/index.scss"
357 | }
358 | ```
359 |
360 | ### Standalone Build (standalone)
361 |
362 | **Purpose:** Build single-file XMLUI runtime for buildless deployments
363 |
364 | **Entry Point:** `src/index-standalone.ts`
365 |
366 | **Output Format:** UMD bundle (`xmlui-standalone.umd.js`)
367 |
368 | **Key Features:**
369 |
370 | - Self-contained runtime with all dependencies
371 | - MSW worker enabled for API mocking
372 | - Version stamping with build date
373 | - Can be loaded via `<script>` tag in browsers
374 | - Supports buildless app execution
375 |
376 | **Use Cases:**
377 |
378 | - CDN distribution
379 | - Buildless application deployment
380 | - Prototyping and demos
381 | - Environments without npm/build tools
382 |
383 | ### Metadata Build (metadata)
384 |
385 | **Purpose:** Extract component metadata for documentation and tooling
386 |
387 | **Entry Point:** `src/components/collectedComponentMetadata.ts`
388 |
389 | **Output:** `xmlui-metadata.js`
390 |
391 | **Use Cases:**
392 |
393 | - Generating documentation
394 | - Language server autocomplete
395 | - Component explorer tools
396 | - API reference generation
397 |
398 | **Workflow:**
399 |
400 | ```bash
401 | # Extract metadata
402 | npm run build:xmlui-metadata
403 |
404 | # Generate documentation from metadata
405 | npm run generate-docs
406 |
407 | # Create summary files
408 | npm run generate-docs-summaries
409 | ```
410 |
411 | ## Package Structure
412 |
413 | ### Source Layout
414 |
415 | ```
416 | src/
417 | ├── index.ts # Main framework entry
418 | ├── index-standalone.ts # Standalone runtime entry
419 | ├── components/ # Core components
420 | ├── parsers/ # .xmlui parser
421 | ├── language-server/ # LSP implementation
422 | ├── syntax/ # Editor syntax support
423 | └── styles/ # Framework SCSS
424 | ```
425 |
426 | ### Build Output (after npm publish)
427 |
428 | ```
429 | dist/
430 | ├── lib/ # Library build
431 | │ ├── xmlui.mjs
432 | │ ├── xmlui.d.ts
433 | │ ├── xmlui-parser.mjs
434 | │ ├── language-server.mjs
435 | │ └── scss/ # SCSS source files
436 | ├── standalone/ # Standalone build
437 | │ └── xmlui-standalone.umd.js
438 | ├── metadata/ # Metadata build
439 | │ └── xmlui-metadata.js
440 | └── scripts/
441 | └── bin/
442 | └── vite-xmlui-plugin.js
443 | ```
444 |
445 | ### Bin Scripts
446 |
447 | ```
448 | bin/
449 | ├── bootstrap.js # CLI entry (ts-node setup)
450 | ├── index.ts # Command router
451 | ├── build.ts # Build implementation
452 | ├── build-lib.ts # Library build
453 | ├── start.ts # Dev server
454 | ├── preview.ts # Preview server
455 | ├── vite-xmlui-plugin.ts # Vite plugin
456 | └── viteConfig.ts # Shared Vite config
457 | ```
458 |
459 | ## Building XMLUI Extensions
460 |
461 | XMLUI extensions are npm packages that provide reusable component libraries. The build system supports extension development through the same CLI commands used for framework and application builds.
462 |
463 | ### Extension Build Commands
464 |
465 | Extensions use standard npm scripts that invoke the `xmlui` CLI:
466 |
467 | **package.json example:**
468 |
469 | ```json
470 | {
471 | "scripts": {
472 | "start": "xmlui start",
473 | "build:extension": "xmlui build-lib",
474 | "build-watch": "xmlui build-lib --watch",
475 | "build:demo": "xmlui build",
476 | "build:meta": "xmlui build-lib --mode=metadata"
477 | }
478 | }
479 | ```
480 |
481 | **Command Reference:**
482 |
483 | | Command | CLI Equivalent | Purpose | Output |
484 | | ------------------------- | --------------------------------- | -------------------------- | ----------------------------- |
485 | | `npm start` | `xmlui start` | Dev server for demo app | Dev server with HMR |
486 | | `npm run build:extension` | `xmlui build-lib` | Build extension library | `dist/` with .js, .d.ts, .css |
487 | | `npm run build-watch` | `xmlui build-lib --watch` | Watch mode for development | Continuous rebuilds |
488 | | `npm run build:demo` | `xmlui build` | Build demo application | Production demo build |
489 | | `npm run build:meta` | `xmlui build-lib --mode=metadata` | Extract component metadata | Metadata for docs/LSP |
490 |
491 | ### Extension Build Workflow
492 |
493 | **Development Process:**
494 |
495 | ```bash
496 | # Terminal 1: Watch extension builds
497 | npm run build-watch
498 |
499 | # Terminal 2: Run demo app with HMR
500 | npm start
501 | ```
502 |
503 | **Build Output:**
504 |
505 | ```
506 | dist/
507 | ├── xmlui-extension-name.js # CommonJS bundle
508 | ├── xmlui-extension-name.mjs # ES module bundle
509 | ├── xmlui-extension-name.d.ts # TypeScript declarations
510 | └── *.css # Extracted component styles
511 | ```
512 |
513 | ### Extension Distribution
514 |
515 | **Publishing to npm:**
516 |
517 | ```bash
518 | # Build all artifacts
519 | npm run build:extension
520 | npm run build:meta
521 |
522 | # Publish
523 | npm publish
524 | ```
525 |
526 | **Package Configuration:**
527 |
528 | ```json
529 | {
530 | "name": "xmlui-myextension",
531 | "main": "./dist/xmlui-myextension.js",
532 | "module": "./dist/xmlui-myextension.mjs",
533 | "exports": {
534 | ".": {
535 | "import": "./dist/xmlui-myextension.mjs",
536 | "require": "./dist/xmlui-myextension.js"
537 | },
538 | "./*.css": {
539 | "import": "./dist/*.css",
540 | "require": "./dist/*.css"
541 | }
542 | },
543 | "files": ["dist"]
544 | }
545 | ```
546 |
547 | ### Using Extensions
548 |
549 | **Installation:**
550 |
551 | ```bash
552 | npm install xmlui-myextension
553 | ```
554 |
555 | **Integration:**
556 |
557 | ```typescript
558 | import { startApp } from "xmlui";
559 | import myExtension from "xmlui-myextension";
560 | import "xmlui-myextension/ComponentName.css";
561 |
562 | const runtime = import.meta.glob(`/demo/**`, { eager: true });
563 | startApp(runtime, [myExtension]);
564 | ```
565 |
566 | ### Example: xmlui-website-blocks
567 |
568 | **Reference implementation in the monorepo:**
569 |
570 | ```
571 | packages/xmlui-website-blocks/
572 | ├── package.json # Extension package config
573 | ├── index.ts # Entry point with startApp
574 | ├── src/ # Extension components
575 | │ └── index.tsx # Component registry export
576 | ├── demo/ # Demo XMLUI application
577 | │ └── Main.xmlui
578 | └── dist/ # Build output
579 | ```
580 |
581 | **Build commands:**
582 |
583 | ```bash
584 | cd packages/xmlui-website-blocks
585 |
586 | # Development
587 | npm start # Demo app at http://localhost:5173
588 |
589 | # Building
590 | npm run build:extension # Library build
591 | npm run build:demo # Demo app build
592 | npm run build:meta # Metadata extraction
593 | ```
594 |
595 | ## Development Workflow
596 |
597 | ### Framework Development
598 |
599 | **Setup:**
600 |
601 | ```bash
602 | cd xmlui
603 | npm install
604 | ```
605 |
606 | **Development Loop:**
607 |
608 | ```bash
609 | # Terminal 1: Watch mode for library
610 | npm run build:bin
611 | xmlui build-lib --watch
612 |
613 | # Terminal 2: Dev server for test app
614 | cd src/testing/infrastructure
615 | xmlui start
616 | ```
617 |
618 | **Testing:**
619 |
620 | ```bash
621 | # Unit tests
622 | npm run test:unit
623 |
624 | # E2E tests
625 | npm run test:e2e-smoke
626 | npm run test:e2e-non-smoke
627 |
628 | # Interactive E2E
629 | npm run test:e2e-ui
630 | ```
631 |
632 | **Publishing:**
633 |
634 | ```bash
635 | # Build all artifacts
636 | npm run build:xmlui
637 | npm run build:xmlui-standalone
638 | npm run build:xmlui-metadata
639 |
640 | # Publish to npm (uses clean-package to transform package.json)
641 | npm publish
642 | ```
643 |
644 | ### Application Development
645 |
646 | **Create New App:**
647 |
648 | ```bash
649 | # Create app directory
650 | mkdir my-xmlui-app
651 | cd my-xmlui-app
652 |
653 | # Initialize with Main.xmlui
654 | echo '<App><Text>Hello XMLUI</Text></App>' > Main.xmlui
655 |
656 | # Create index.html
657 | cat > index.html << 'EOF'
658 | <!DOCTYPE html>
659 | <html>
660 | <head>
661 | <title>My XMLUI App</title>
662 | </head>
663 | <body>
664 | <div id="root"></div>
665 | <script src="https://unpkg.com/xmlui@latest/dist/standalone/xmlui-standalone.umd.js"></script>
666 | </body>
667 | </html>
668 | EOF
669 |
670 | # Serve with any static server
671 | npx serve
672 | ```
673 |
674 | **Built App Development:**
675 |
676 | ```bash
677 | # Install xmlui
678 | npm install xmlui
679 |
680 | # Add vite config
681 | cat > vite.config.ts << 'EOF'
682 | import { defineConfig } from 'vite';
683 | import react from '@vitejs/plugin-react';
684 | import ViteXmlui from 'xmlui/vite-xmlui-plugin';
685 |
686 | export default defineConfig({
687 | plugins: [react(), ViteXmlui()]
688 | });
689 | EOF
690 |
691 | # Start dev server
692 | xmlui start
693 |
694 | # Build for production
695 | xmlui build --prod
696 | ```
697 |
698 | **Key Scripts:**
699 |
700 | ```bash
701 | # Development
702 | xmlui start # Dev server with HMR
703 | xmlui start --withMock=false # Without API mocking
704 | xmlui start --proxy /api->... # With backend proxy
705 |
706 | # Production builds
707 | xmlui build --prod # Optimized build
708 | xmlui build --buildMode=INLINE_ALL --flatDist
709 |
710 | # Deployment
711 | xmlui build --prod --withHostingMetaFiles
712 | xmlui zip-dist
713 | ```
714 |
715 | ### Quick Reference Table
716 |
717 | This table summarizes when to run builds across different contexts:
718 |
719 | | Context | Scenario | npm Script | Underlying CLI | When to Run | Comments |
720 | | -------------- | ------------------------- | -------------------------------- | ----------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
721 | | **docs/** | Editing `.md` files | `npm start` | `xmlui start` | No build - just refresh browser | Markdown files are served directly; dev server provides hot reload for instant feedback |
722 | | **docs/** | Building docs site | `npm run build:docs` | `xmlui build --buildMode=INLINE_ALL --withMock` | Before deployment | Creates optimized production build with INLINE_ALL mode, downloads latest XMLUI release, generates RSS feed |
723 | | **docs/** | Preview production build | `npm run preview` | `xmlui preview` | After building | Serves production build locally for testing before deployment |
724 | | **xmlui/** | Testing component changes | `npm start-test-bed` | `cd src/testing/infrastructure && xmlui start` | Automatic HMR | Runs dev server in `src/testing/infrastructure`; component changes appear instantly via HMR |
725 | | **xmlui/** | Building framework | `npm run build:xmlui` | `vite build --mode lib` | Before npm publish | Builds library for npm distribution using Vite directly (not xmlui CLI); generates .mjs, .d.ts, and CSS |
726 | | **xmlui/** | Building standalone | `npm run build:xmlui-standalone` | `vite build --mode standalone` | For CDN/buildless | Creates self-contained UMD bundle for `<script>` tag usage; framework builds itself with Vite directly |
727 | | **xmlui/** | Generating metadata | `npm run build:xmlui-metadata` | `vite build --mode metadata` | After component changes, before doc generation | Extracts component metadata into `xmlui-metadata.js` for documentation generation and language server autocomplete. This is the source of truth for component APIs, props, and descriptions. Framework uses Vite directly. |
728 | | **xmlui/** | Full doc generation | `npm run generate-all-docs` | Node scripts (not CLI) | After metadata changes | Runs three scripts: (1) `build:xmlui-metadata` - extracts metadata, (2) `generate-docs` - creates component .md files from metadata, (3) `generate-docs-summaries` - creates overview/summary files. This is the complete pipeline from source code → documentation |
729 | | **xmlui/** | Compile bin scripts | `npm run build:bin` | `tsc -p tsconfig.bin.json` | After changes to bin/\*.ts files | Compiles TypeScript bin scripts (CLI tools) to JavaScript using TypeScript directly; needed when modifying build system or CLI commands |
730 | | **extension/** | Development | `npm start` | `xmlui start` | Keep running during dev | Runs dev server with HMR for demo app; use with build-watch in separate terminal |
731 | | **extension/** | Watch mode build | `npm run build-watch` | `xmlui build-lib --watch` | Keep running during dev | Continuously rebuilds extension library on changes; pair with `npm start` for rapid iteration |
732 | | **extension/** | Building for publish | `npm run build:extension` | `xmlui build-lib` | Before npm publish | Creates distributable library bundle (.mjs, .js, .d.ts, CSS) for npm package |
733 | | **extension/** | Build demo app | `npm run build:demo` | `xmlui build` | For demo deployment | Builds the demo application (not the extension itself) for hosting |
734 | | **extension/** | Extract metadata | `npm run build:meta` | `xmlui build-lib --mode=metadata` | For LSP/docs support | Extracts extension component metadata for language server and documentation |
735 |
736 | **Key principles:**
737 |
738 | - **Development mode uses HMR** - No manual builds needed when running `xmlui start`
739 | - **Production requires explicit builds** - Use `xmlui build` or `npm run build:*` scripts
740 | - **Framework builds itself differently** - XMLUI uses Vite directly (`vite build --mode lib`) instead of the `xmlui` CLI
741 | - **Extensions use the CLI** - Extension developers use `xmlui build-lib` and `xmlui start`
742 | - **npm scripts wrap CLI commands** - Convenience shortcuts with project-specific flags
743 |
744 | ### Build Optimization Tips
745 |
746 | 1. **Development:** Use `xmlui start` for instant feedback
747 | 2. **Testing:** Use `CONFIG_ONLY` mode for faster rebuilds
748 | 3. **Production:** Use `INLINE_ALL` with `--flatDist` for optimal performance
749 | 4. **Debugging:** Enable `--withMock` to test without backend
750 | 5. **Large Apps:** Consider lazy loading with `ALL` mode
751 |
752 | ### Environment Variables
753 |
754 | Build behavior can be controlled via environment variables:
755 |
756 | ```bash
757 | # .env file
758 | NODE_ENV=production
759 | VITE_BUILD_MODE=INLINE_ALL
760 | VITE_MOCK_ENABLED=false
761 | VITE_STANDALONE=true
762 | ```
763 |
764 | **Key Variables:**
765 |
766 | - `VITE_BUILD_MODE` - Component bundling strategy
767 | - `VITE_MOCK_ENABLED` - Enable/disable MSW
768 | - `VITE_STANDALONE` - Standalone runtime mode
769 | - `VITE_INCLUDE_ALL_COMPONENTS` - Bundle all components
770 | - `VITE_XMLUI_VERSION` - Version string for metadata
771 |
772 | ---
773 |
774 | ## See Also
775 |
776 | - [Building the XMLUI Core Package](./build-xmlui.md) - Framework package build with Vite
777 | - [Standalone Rendering Architecture](./standalone-app.md) - How built vs buildless apps work
778 | - [Container-Based State Management](./containers.md) - Runtime state system
779 | - [React Fundamentals](./react-fundamentals.md) - React integration details
780 |
```
