@orangelogic/orange-dam-content-browser-sdk 2.1.52 → 2.1.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env +1 -0
- package/.eslintignore +2 -0
- package/.eslintrc.json +82 -0
- package/.releaserc +17 -0
- package/.travis.yml +20 -0
- package/CBSDKdemo.html +315 -0
- package/GitVersion.yml +18 -0
- package/azure-pipeline.yaml +93 -0
- package/clientlib.config.js +36 -0
- package/config/env.js +105 -0
- package/config/getHttpsConfig.js +67 -0
- package/config/jest/babelTransform.js +30 -0
- package/config/jest/cssTransform.js +14 -0
- package/config/jest/fileTransform.js +41 -0
- package/config/modules.js +135 -0
- package/config/paths.js +79 -0
- package/config/webpack/persistentCache/createEnvironmentHash.js +10 -0
- package/config/webpack.config.js +762 -0
- package/config/webpackDevServer.config.js +128 -0
- package/config-overrides.js +8 -0
- package/gab_extension/GAB.html +85 -0
- package/gab_extension/GoogleChrome/manifest.json +28 -0
- package/gab_extension/GoogleChrome/src/assets/icon48.png +0 -0
- package/gab_extension/GoogleChrome/src/background/index.js +6 -0
- package/gab_extension/GoogleChrome/src/scripts/index.js +347 -0
- package/gab_extension/MozillaFirefox/manifest.json +20 -0
- package/gab_extension/MozillaFirefox/src/assets/icon.png +0 -0
- package/gab_extension/MozillaFirefox/src/background/index.js +5 -0
- package/gab_extension/MozillaFirefox/src/scripts/index.js +347 -0
- package/gab_extension/README.md +11 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Orange DAM Asset Browser Extension.xcodeproj/project.pbxproj +927 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Orange DAM Asset Browser Extension.xcodeproj/project.xcworkspace/contents.xcworkspacedata +7 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Orange DAM Asset Browser Extension.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +8 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Orange DAM Asset Browser Extension.xcodeproj/project.xcworkspace/xcuserdata/oldevmac01.xcuserdatad/UserInterfaceState.xcuserstate +0 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Orange DAM Asset Browser Extension.xcodeproj/xcuserdata/oldevmac01.xcuserdatad/xcschemes/xcschememanagement.plist +19 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Assets.xcassets/AccentColor.colorset/Contents.json +11 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Assets.xcassets/AppIcon.appiconset/Contents.json +63 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Assets.xcassets/Contents.json +6 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Assets.xcassets/LargeIcon.imageset/Contents.json +20 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Base.lproj/Main.html +23 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Resources/Icon.png +0 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Resources/Script.js +24 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/Resources/Style.css +61 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (App)/ViewController.swift +81 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/Shared (Extension)/SafariWebExtensionHandler.swift +26 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (App)/AppDelegate.swift +24 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (App)/Base.lproj/LaunchScreen.storyboard +36 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (App)/Base.lproj/Main.storyboard +38 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (App)/Info.plist +27 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (App)/SceneDelegate.swift +18 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/iOS (Extension)/Info.plist +13 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (App)/AppDelegate.swift +21 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (App)/Base.lproj/Main.storyboard +125 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (App)/Info.plist +8 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (App)/Orange DAM Asset Browser Extension.entitlements +12 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (Extension)/Info.plist +13 -0
- package/gab_extension/Safari/Orange DAM Asset Browser Extension/macOS (Extension)/Orange DAM Asset Browser Extension.entitlements +10 -0
- package/package.json +8 -49
- package/public/index.html +92 -0
- package/scripts/build.js +218 -0
- package/scripts/start.js +154 -0
- package/scripts/test.js +53 -0
- package/src/App.tsx +98 -0
- package/src/AppContext.ts +18 -0
- package/src/GlobalConfigContext.ts +46 -0
- package/src/components/ArrayClamp/ArrayClamp.styled.ts +42 -0
- package/src/components/ArrayClamp/ArrayClamp.tsx +167 -0
- package/src/components/ArrayClamp/index.ts +1 -0
- package/src/components/Browser/Browser.styled.ts +82 -0
- package/src/components/Browser/Browser.tsx +284 -0
- package/src/components/Browser/BrowserItem.tsx +98 -0
- package/src/components/ControlBar/ControlBar.constants.tsx +66 -0
- package/src/components/ControlBar/ControlBar.styled.ts +82 -0
- package/src/components/ControlBar/ControlBar.tsx +528 -0
- package/src/components/ControlBar/Facet/Facet.tsx +113 -0
- package/src/components/ControlBar/Facet/index.ts +1 -0
- package/src/components/FormatDialog/CropPreviewer/CropPreviewer.tsx +224 -0
- package/{build/components/FormatDialog/CropPreviewer/index.d.ts → src/components/FormatDialog/CropPreviewer/index.ts} +1 -1
- package/src/components/FormatDialog/CustomRendition/CustomRendition.constants.ts +24 -0
- package/src/components/FormatDialog/CustomRendition/CustomRendition.styled.ts +57 -0
- package/src/components/FormatDialog/CustomRendition/CustomRendition.tsx +178 -0
- package/src/components/FormatDialog/CustomRendition/index.ts +1 -0
- package/src/components/FormatDialog/CustomRendition/transformations/Crop.tsx +249 -0
- package/src/components/FormatDialog/CustomRendition/transformations/Extension.tsx +54 -0
- package/src/components/FormatDialog/CustomRendition/transformations/Format.tsx +86 -0
- package/src/components/FormatDialog/CustomRendition/transformations/Resize.tsx +176 -0
- package/src/components/FormatDialog/CustomRendition/transformations/Rotate.tsx +101 -0
- package/{build/components/FormatDialog/CustomRendition/transformations/index.d.ts → src/components/FormatDialog/CustomRendition/transformations/index.ts} +1 -3
- package/src/components/FormatDialog/FormatDialog.styled.ts +137 -0
- package/src/components/FormatDialog/FormatDialog.tsx +1533 -0
- package/src/components/FormatDialog/Previewer/Previewer.styled.ts +31 -0
- package/src/components/FormatDialog/Previewer/Previewer.tsx +143 -0
- package/src/components/FormatDialog/Previewer/index.ts +1 -0
- package/src/components/FormatDialog/ProxyMenu/ProxyMenu.styled.ts +88 -0
- package/src/components/FormatDialog/ProxyMenu/ProxyMenu.tsx +74 -0
- package/src/components/FormatDialog/ProxyMenu/index.ts +1 -0
- package/src/components/FormatDialog/TrackingParameters/TrackingParameters.tsx +59 -0
- package/src/components/FormatDialog/TrackingParameters/index.ts +1 -0
- package/src/components/FormatDialog/index.ts +1 -0
- package/src/components/Header/Header.styled.ts +51 -0
- package/src/components/Header/Header.tsx +118 -0
- package/src/components/Loader/Loader.tsx +37 -0
- package/src/components/Loader/index.ts +1 -0
- package/src/components/NoResult/NoResult.tsx +37 -0
- package/src/components/NoResult/index.tsx +1 -0
- package/src/components/Result/AssetCard/AssetCard.styled.ts +120 -0
- package/src/components/Result/AssetCard/AssetCard.tsx +192 -0
- package/src/components/Result/AssetCard/AssetCardWrapper.styled.ts +35 -0
- package/src/components/Result/AssetCard/AssetCardWrapper.tsx +165 -0
- package/src/components/Result/AssetCard/index.ts +1 -0
- package/src/components/Result/AssetPreview/AssetPreview.styled.ts +108 -0
- package/src/components/Result/AssetPreview/AssetPreview.tsx +78 -0
- package/src/components/Result/AssetPreview/ImagePreview/ImagePreview.tsx +42 -0
- package/src/components/Result/AssetPreview/ImagePreview/index.ts +1 -0
- package/src/components/Result/AssetPreview/OtherPreview/OtherPreview.styled.ts +23 -0
- package/src/components/Result/AssetPreview/OtherPreview/OtherPreview.tsx +28 -0
- package/src/components/Result/AssetPreview/OtherPreview/index.ts +1 -0
- package/src/components/Result/AssetPreview/VideoPreview/VideoPreview.tsx +132 -0
- package/src/components/Result/AssetPreview/VideoPreview/index.ts +1 -0
- package/src/components/Result/AssetPreview/index.ts +1 -0
- package/src/consts/asset.ts +16 -0
- package/src/consts/data.ts +17 -0
- package/src/index.tsx +305 -0
- package/src/page/Authenticate/Authenticate.tsx +232 -0
- package/src/page/Authenticate/ConnectingBackground.tsx +44 -0
- package/src/page/Authenticate/index.tsx +94 -0
- package/src/page/Home/Home.styled.ts +46 -0
- package/src/page/Home/Home.tsx +941 -0
- package/src/react-web-component.d.ts +4617 -0
- package/src/store/assets/assets.api.ts +167 -0
- package/src/store/assets/assets.service.ts +223 -0
- package/src/store/assets/assets.slice.ts +104 -0
- package/src/store/auth/auth.service.ts +71 -0
- package/src/store/auth/auth.slice.ts +295 -0
- package/src/store/index.ts +27 -0
- package/src/store/search/search.api.ts +319 -0
- package/src/store/search/search.slice.ts +28 -0
- package/src/store/user/user.api.ts +29 -0
- package/src/styles.css +42 -0
- package/src/types/assets.ts +71 -0
- package/src/types/auth.ts +42 -0
- package/src/types/common.ts +11 -0
- package/src/types/download.ts +8 -0
- package/src/types/navigation.ts +3 -0
- package/src/types/search.ts +116 -0
- package/{build/types/storage.d.ts → src/types/storage.ts} +1 -1
- package/src/types/user.ts +6 -0
- package/src/utils/api.ts +186 -0
- package/src/utils/array.ts +25 -0
- package/src/utils/constants.ts +12 -0
- package/src/utils/fetch.ts +116 -0
- package/src/utils/getRequestUrl.ts +15 -0
- package/src/utils/hooks.ts +36 -0
- package/src/utils/icon.ts +22 -0
- package/src/utils/image.ts +157 -0
- package/src/utils/number.ts +11 -0
- package/src/utils/rotate.ts +23 -0
- package/src/utils/storage.ts +184 -0
- package/src/utils/string.ts +24 -0
- package/src/view/AssetsPicker.tsx +24 -0
- package/src/web-component.d.ts +8151 -0
- package/tsconfig.eslint.json +10 -0
- package/tsconfig.json +37 -0
- package/build/ApiService.d.ts +0 -15
- package/build/App.d.ts +0 -62
- package/build/AppContext.d.ts +0 -18
- package/build/GlobalConfigContext.d.ts +0 -32
- package/build/OrangeDAMContentBrowserSDK.min.css +0 -2
- package/build/OrangeDAMContentBrowserSDK.min.css.map +0 -1
- package/build/OrangeDAMContentBrowserSDK.min.js +0 -11468
- package/build/OrangeDAMContentBrowserSDK.min.js.map +0 -1
- package/build/asset-manifest.json +0 -13
- package/build/components/ArrayClamp/ArrayClamp.d.ts +0 -10
- package/build/components/ArrayClamp/ArrayClamp.styled.d.ts +0 -1
- package/build/components/ArrayClamp/index.d.ts +0 -1
- package/build/components/Browser/Browser.constants.d.ts +0 -3
- package/build/components/Browser/Browser.d.ts +0 -21
- package/build/components/Browser/Browser.styled.d.ts +0 -2
- package/build/components/Browser/BrowserItem.d.ts +0 -13
- package/build/components/Browser/LoadMoreButton.d.ts +0 -9
- package/build/components/ControlBar/ControlBar.constants.d.ts +0 -10
- package/build/components/ControlBar/ControlBar.d.ts +0 -23
- package/build/components/ControlBar/ControlBar.styled.d.ts +0 -1
- package/build/components/ControlBar/Facet/Facet.d.ts +0 -14
- package/build/components/ControlBar/Facet/index.d.ts +0 -1
- package/build/components/FormatDialog/CropPreviewer/CropPreviewer.d.ts +0 -41
- package/build/components/FormatDialog/CustomRendition/CustomRendition.constants.d.ts +0 -5
- package/build/components/FormatDialog/CustomRendition/CustomRendition.d.ts +0 -56
- package/build/components/FormatDialog/CustomRendition/CustomRendition.styled.d.ts +0 -1
- package/build/components/FormatDialog/CustomRendition/index.d.ts +0 -1
- package/build/components/FormatDialog/CustomRendition/transformations/Crop.d.ts +0 -26
- package/build/components/FormatDialog/CustomRendition/transformations/Extension.d.ts +0 -11
- package/build/components/FormatDialog/CustomRendition/transformations/Format.d.ts +0 -10
- package/build/components/FormatDialog/CustomRendition/transformations/Metadata.d.ts +0 -7
- package/build/components/FormatDialog/CustomRendition/transformations/Quality.d.ts +0 -7
- package/build/components/FormatDialog/CustomRendition/transformations/Resize.d.ts +0 -18
- package/build/components/FormatDialog/CustomRendition/transformations/Rotate.d.ts +0 -8
- package/build/components/FormatDialog/FormatDialog.d.ts +0 -49
- package/build/components/FormatDialog/FormatDialog.styled.d.ts +0 -3
- package/build/components/FormatDialog/Previewer/Previewer.d.ts +0 -17
- package/build/components/FormatDialog/Previewer/Previewer.styled.d.ts +0 -1
- package/build/components/FormatDialog/Previewer/index.d.ts +0 -1
- package/build/components/FormatDialog/ProxyMenu/ProxyMenu.d.ts +0 -20
- package/build/components/FormatDialog/ProxyMenu/ProxyMenu.styled.d.ts +0 -2
- package/build/components/FormatDialog/ProxyMenu/index.d.ts +0 -1
- package/build/components/FormatDialog/TrackingParameters/TrackingParameters.d.ts +0 -13
- package/build/components/FormatDialog/TrackingParameters/index.d.ts +0 -1
- package/build/components/FormatDialog/VersionHistory/VersionHistory.d.ts +0 -6
- package/build/components/FormatDialog/VersionHistory/VersionHistory.styled.d.ts +0 -1
- package/build/components/FormatDialog/VersionHistory/index.d.ts +0 -1
- package/build/components/FormatDialog/index.d.ts +0 -1
- package/build/components/Header/Header.d.ts +0 -15
- package/build/components/Header/Header.styled.d.ts +0 -5
- package/build/components/Loader/Loader.d.ts +0 -7
- package/build/components/Loader/index.d.ts +0 -1
- package/build/components/NoResult/NoResult.d.ts +0 -7
- package/build/components/NoResult/index.d.ts +0 -1
- package/build/components/Result/AssetCard/AssetCard.d.ts +0 -15
- package/build/components/Result/AssetCard/AssetCard.styled.d.ts +0 -2
- package/build/components/Result/AssetCard/AssetCardWrapper.d.ts +0 -18
- package/build/components/Result/AssetCard/AssetCardWrapper.styled.d.ts +0 -1
- package/build/components/Result/AssetCard/index.d.ts +0 -1
- package/build/components/Result/AssetPreview/AssetPreview.d.ts +0 -11
- package/build/components/Result/AssetPreview/AssetPreview.styled.d.ts +0 -1
- package/build/components/Result/AssetPreview/ImagePreview/ImagePreview.d.ts +0 -11
- package/build/components/Result/AssetPreview/ImagePreview/index.d.ts +0 -1
- package/build/components/Result/AssetPreview/OtherPreview/OtherPreview.d.ts +0 -9
- package/build/components/Result/AssetPreview/OtherPreview/OtherPreview.styled.d.ts +0 -1
- package/build/components/Result/AssetPreview/OtherPreview/index.d.ts +0 -1
- package/build/components/Result/AssetPreview/VideoPreview/VideoPreview.d.ts +0 -11
- package/build/components/Result/AssetPreview/VideoPreview/index.d.ts +0 -1
- package/build/components/Result/AssetPreview/index.d.ts +0 -1
- package/build/consts/asset.d.ts +0 -14
- package/build/consts/auth.d.ts +0 -4
- package/build/consts/data.d.ts +0 -21
- package/build/index.d.ts +0 -225
- package/build/index.html +0 -1
- package/build/page/Authenticate/Authenticate.d.ts +0 -2
- package/build/page/Authenticate/ConnectingBackground.d.ts +0 -8
- package/build/page/Authenticate/index.d.ts +0 -2
- package/build/page/Home/Home.d.ts +0 -6
- package/build/page/Home/Home.styled.d.ts +0 -2
- package/build/setupTests.d.ts +0 -1
- package/build/store/assets/assets.api.d.ts +0 -66
- package/build/store/assets/assets.service.d.ts +0 -23
- package/build/store/assets/assets.slice.d.ts +0 -65
- package/build/store/auth/auth.service.d.ts +0 -10
- package/build/store/auth/auth.slice.d.ts +0 -76
- package/build/store/index.d.ts +0 -368
- package/build/store/search/search.api.d.ts +0 -39
- package/build/store/search/search.slice.d.ts +0 -12
- package/build/store/user/user.api.d.ts +0 -5
- package/build/types/assets.d.ts +0 -68
- package/build/types/auth.d.ts +0 -35
- package/build/types/common.d.ts +0 -11
- package/build/types/download.d.ts +0 -8
- package/build/types/navigation.d.ts +0 -3
- package/build/types/search.d.ts +0 -148
- package/build/types/user.d.ts +0 -7
- package/build/utils/api.d.ts +0 -27
- package/build/utils/array.d.ts +0 -13
- package/build/utils/constants.d.ts +0 -11
- package/build/utils/function.d.ts +0 -1
- package/build/utils/getRequestUrl.d.ts +0 -1
- package/build/utils/hooks.d.ts +0 -1
- package/build/utils/icon.d.ts +0 -3
- package/build/utils/image.d.ts +0 -24
- package/build/utils/number.d.ts +0 -4
- package/build/utils/rotate.d.ts +0 -4
- package/build/utils/storage.d.ts +0 -23
- package/build/utils/string.d.ts +0 -12
- package/build/view/AssetsPicker.d.ts +0 -6
- /package/{build → public}/favicon.ico +0 -0
- /package/{build → public}/logo192.png +0 -0
- /package/{build → public}/logo512.png +0 -0
- /package/{build → public}/manifest.json +0 -0
- /package/{build → public}/robots.txt +0 -0
- /package/{build/components/Browser/index.d.ts → src/components/Browser/index.ts} +0 -0
- /package/{build/components/ControlBar/index.d.ts → src/components/ControlBar/index.ts} +0 -0
- /package/{build/components/Header/index.d.ts → src/components/Header/index.ts} +0 -0
- /package/{build/page/Home/index.d.ts → src/page/Home/index.ts} +0 -0
|
@@ -0,0 +1,4617 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
import { HTMLAttributes, DetailedHTMLProps } from 'react';
|
|
3
|
+
|
|
4
|
+
import { CxIcon, CxIconButton, CxAlert, CxAnimatedImage, CxAnimation, CxAvatar, CxBadge, CxBreadcrumbItem, CxBreadcrumb, CxSpinner, CxButton, CxButtonGroup, CxCard, CxCarouselItem, CxCarousel, CxPopup, CxTooltip, CxMarkdown, CxTypography, CxCheckbox, CxMenuItem, CxMenu, CxInput, CxDropdown, CxDivider, CxVisuallyHidden, CxColorPicker, CxCopyButton, CxDetails, CxDialog, CxDrawer, CxElementClamp, CxFormatBytes, CxFormatDate, CxFormatNumber, CxHubConnection, CxImageComparer, CxInclude, CxInputGroup, CxResizeObserver, CxLineClamp, CxMenuLabel, CxMenuSection, CxMutationObserver, CxOption, CxTag, CxSelect, CxTreeItem, CxPagination, CxProgressBar, CxProgressRing, CxQrCode, CxRadio, CxRadioButton, CxRadioCard, CxRadioGroup, CxRange, CxRating, CxRelativeTime, CxSkeleton, CxSpace, CxSplitPanel, CxStep, CxStepper, CxSwitch, CxTab, CxTabPanel, CxTabGroup, CxTextarea, CxTree, CxGrid, CxGridItem, CxChatbot, CxConfirmPopover, CxFileOnDemand, CxSidebarLayout, CxGraphView, CxStepperWizard, CxClusterManagement, CxStorybook, CxSidebar, CxMultiSelect, CxTemplateSwitcher, CxTextToSpeech, CxDownloader, CxComment } from './web-component';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
export type CxMarkdownRendererObject = { };
|
|
8
|
+
export type CxChatbotChatbotEvent = { event: string; excludedFromPurposes: string[]; label: string; };
|
|
9
|
+
export type CxFileOnDemandAssetsProp = { assets: CxFileOnDemandAsset[]; hasMore: boolean; };
|
|
10
|
+
export type CxFileOnDemandAsset = { docType: string; fileName: string; isInFavorite: boolean; isUploadCompleted: boolean; key: string; parentRecordId: string; recordId: string; remainingSize: number; remainingTime: number; size: number; thumbnail: string; uploadId: string; uploadStatus: 'CANCELED' | 'FAILED' | 'INPROGRESS' | 'PENDINGCOMPLETE' | 'SUCCESS'; uploadTimestamp: number; uploaded: number; };
|
|
11
|
+
export type CxFileOnDemandFolderOption = { id: string; label: string; };
|
|
12
|
+
export type CxFileOnDemandSettings = { cacheLocation: string; cacheSize: number; config: { activeFoldersMode: boolean; launchOnStartup: boolean; monitoringActivated: boolean; mountPoint: string; mountProxy: boolean; proxyTypes: 'Image' | 'Video' | 'Audio'[]; rootIDs: string[]; siteUrl: string; }; };
|
|
13
|
+
export type CxGraphViewWorkflow = { data: CxGraphViewData; description: string; id: string; links: CxGraphViewEdge[]; name: string; node_types: CxGraphViewRecord; nodes: CxGraphViewNode[]; type: string; };
|
|
14
|
+
export type CxGraphViewData = { fromTransition: string; name: string; source: string; transitions: CxGraphViewTransition[]; };
|
|
15
|
+
export type CxGraphViewTransition = { description: string; icon: string; icon_rotation: number; id: string; name: string; required: boolean; type: string; };
|
|
16
|
+
export type CxGraphViewEdge = { fromNode: string; fromTransition: string; icon: string; iconRotation: number; toNode: string; };
|
|
17
|
+
export type CxGraphViewRecord = dictionary;
|
|
18
|
+
export type CxGraphViewNodeType = { allows_loop: boolean; color: string; icon: string; name: string; };
|
|
19
|
+
export type CxGraphViewNode = { category: string; color: string; data: CxGraphViewData; description: string; icon: string; id: string; messages: string[]; name: string; state: 'Error'; summaries: CxGraphViewSummary[]; type: 'Action' | 'Decision' | 'Status' | 'Trigger' | 'Agent' | 'Ghost'; unordered: boolean; unorderedText: string; };
|
|
20
|
+
export type CxGraphViewSummary = { icon: string; texts: string[]; };
|
|
21
|
+
export type CxStepperWizardStepData = { color: string; description: string; icon: string; iconVariant: 'outlined' | 'filled' | 'fa'; id: string; name: string; readonly: boolean; state: 'Done' | 'Active' | 'None' | 'Disabled'; };
|
|
22
|
+
export type CxStorybookRecord = { };
|
|
23
|
+
export type CxMultiSelectColumnData = { id: string; items: { group: string; id: string; index: string; text: string; tooltip: string; type: string; }[]; sort: boolean; title: string; };
|
|
24
|
+
export type CxTemplateSwitcherTemplateSwitcherProps = { VFormID: string; categories: CxTemplateSwitcherCategory[]; defaultDirectionWhenSortChange: string; defaultSettings: CxTemplateSwitcherSettings; defaultSortForResequence: string; disabledCountForViews: string[]; disabledDeployStackForViews: string[]; disabledGroupByForViews: string[]; disabledSeeThruForViews: string[]; disabledSortForViews: string[]; events: CxTemplateSwitcherEvents; forceSortOrderWhenSeethruOff: string; groupBy: CxTemplateSwitcherOption[]; hideDeployStackForViews: string[]; hideGroupByForViews: string[]; initSettings: CxTemplateSwitcherSettings; itemsPerPage: CxTemplateSwitcherOption[]; moreOptions: CxTemplateSwitcherMoreOptions; sections: CxTemplateSwitcherSectionOption[]; sortOrder: CxTemplateSwitcherSortOrder[]; view: CxTemplateSwitcherOption[]; };
|
|
25
|
+
export type CxTemplateSwitcherCategory = { id: string; name: string; };
|
|
26
|
+
export type CxTemplateSwitcherSettings = { darkMode: boolean; deployStack: boolean; direction: string; groupBy: string; itemsPerPage: string; resequence: boolean; seeThru: boolean; showBinnedAssets: boolean; sortOrder: string; view: string; };
|
|
27
|
+
export type CxTemplateSwitcherEvents = dictionary;
|
|
28
|
+
export type CxTemplateSwitcherEventOption = { delay: string; returnType: string; };
|
|
29
|
+
export type CxTemplateSwitcherOption = { category: string; eventName: string; id: string; isSetting: boolean; name: string; selectedTip: string; subCategory: string; unselectedTip: string; };
|
|
30
|
+
export type CxTemplateSwitcherMoreOptions = dictionary;
|
|
31
|
+
export type CxTemplateSwitcherSectionOption = { id: string; name: string; };
|
|
32
|
+
export type CxTemplateSwitcherSortOrder = { category: string; eventName: string; id: string; isSetting: boolean; name: string; selectedTip: string; subCategory: string; unselectedTip: string; direction: CxTemplateSwitcherOption[]; };
|
|
33
|
+
export type CxTextToSpeechTextToSpeechData = { HtmlData: string; SsmlData: { LanguageCode: string; Name: string; SsmlText: string; }; };
|
|
34
|
+
export type CxDownloaderExecutionContext = { defaultDownloadFolder: CxDownloaderRaw; downloadRequestedEvent: CxDownloaderEvent; instructionsURL: CxDownloaderRaw; isReady: CxDownloaderRaw; locationPickedEvent: CxDownloaderEvent; locationRequestedEvent: CxDownloaderEvent; openDirectoryPickerAction: CxDownloaderAction; openDownloaderEvent: CxDownloaderEvent; promptAction: CxDownloaderAction; promptRepliedEvent: CxDownloaderEvent; configurationData: CxDownloaderConfigurationData; };
|
|
35
|
+
export type CxDownloaderRaw = { value: string; };
|
|
36
|
+
export type CxDownloaderEvent = { };
|
|
37
|
+
export type CxDownloaderAction = { doNothing: boolean; };
|
|
38
|
+
export type CxDownloaderConfigurationData = { allowForcedDownloadLocation: boolean; autoUnlockAfterMinutes: number; backgroundJobDefaultInterval: number; chunkSize: number; dateFormat: string; defaultMode: 'normal' | 'rocket'; downloadChunkMaxRetries: number; downloadChunkRetryMaxWait: number; downloadChunkRetryMinWait: number; downloadDirectlyFromCloudIfPossible: boolean; downloadSpeedMonitorDuration: number; instructionsPopupHeight: number; instructionsPopupWidth: number; massActionBatchSize: number; maxChunkSize: number; maxRetryPerChunk: number; minChunkSize: number; missingFileErrorMessage: string; networkErrorMessage: string; normalMode: { backgroundJobInstancesCount: CxDownloaderRecord; backgroundJobInterval: CxDownloaderRecord; maxInProgressChunksPerFile: number; }; notEnoughStorageErrorMessage: string; popupId: string; rocketMode: { backgroundJobInstancesCount: CxDownloaderRecord; backgroundJobInterval: CxDownloaderRecord; maxInProgressChunksPerFile: number; }; shouldHandlePathLimit: boolean; verbose: boolean; };
|
|
39
|
+
export type CxDownloaderRecord = dictionary;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* @summary Icons are symbols that can be used to represent various options within an application.
|
|
43
|
+
*
|
|
44
|
+
* https://fonts.google.com/icons
|
|
45
|
+
*
|
|
46
|
+
* @csspart span - The internal span element.
|
|
47
|
+
*/
|
|
48
|
+
interface CxIconAttributes extends HTMLAttributes<CxIcon> {
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* The name of the icon to draw. Available names depend on the icon library being used.
|
|
52
|
+
*/
|
|
53
|
+
name?: string;
|
|
54
|
+
/**
|
|
55
|
+
* The src of the icon for custom icons.
|
|
56
|
+
*/
|
|
57
|
+
src?: string;
|
|
58
|
+
/**
|
|
59
|
+
* An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and
|
|
60
|
+
* ignored by assistive devices.
|
|
61
|
+
*/
|
|
62
|
+
label?: string;
|
|
63
|
+
/**
|
|
64
|
+
* The variant of the icon to draw.
|
|
65
|
+
*/
|
|
66
|
+
variant?: 'outlined' | 'filled' | 'round' | 'sharp' | 'two-tone' | 'fa';
|
|
67
|
+
/**
|
|
68
|
+
* The class of the Font Awesome icon to draw
|
|
69
|
+
*/
|
|
70
|
+
iconClass?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Make localization attributes reactive
|
|
73
|
+
*/
|
|
74
|
+
dir?: string;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
*/
|
|
78
|
+
lang?: string;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* @summary Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.
|
|
82
|
+
*
|
|
83
|
+
* @dependency cx-icon
|
|
84
|
+
*
|
|
85
|
+
* @event cx-blur - Emitted when the icon button loses focus.
|
|
86
|
+
* @event cx-focus - Emitted when the icon button gains focus.
|
|
87
|
+
*
|
|
88
|
+
* @csspart base - The component's base wrapper.
|
|
89
|
+
*/
|
|
90
|
+
interface CxIconButtonAttributes extends HTMLAttributes<CxIconButton> {
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* The name of the icon to draw.
|
|
94
|
+
*/
|
|
95
|
+
name?: string;
|
|
96
|
+
/**
|
|
97
|
+
* The variant of the icon to draw.
|
|
98
|
+
*/
|
|
99
|
+
variant?: 'outlined' | 'filled' | 'round' | 'sharp' | 'two-tone';
|
|
100
|
+
/**
|
|
101
|
+
* An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and
|
|
102
|
+
* can result in XSS attacks.
|
|
103
|
+
*/
|
|
104
|
+
src?: string;
|
|
105
|
+
/**
|
|
106
|
+
* When set, the underlying button will be rendered as an `a` with this `href` instead of a `button`.
|
|
107
|
+
*/
|
|
108
|
+
href?: string;
|
|
109
|
+
/**
|
|
110
|
+
* Tells the browser where to open the link. Only used when `href` is set.
|
|
111
|
+
*/
|
|
112
|
+
target?: '_blank' | '_parent' | '_self' | '_top';
|
|
113
|
+
/**
|
|
114
|
+
* Tells the browser to download the linked file as this filename. Only used when `href` is set.
|
|
115
|
+
*/
|
|
116
|
+
download?: string;
|
|
117
|
+
/**
|
|
118
|
+
* A description that gets read by assistive devices. For optimal accessibility, you should always include a label
|
|
119
|
+
* that describes what the icon button does.
|
|
120
|
+
*/
|
|
121
|
+
label?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Disables the button.
|
|
124
|
+
*/
|
|
125
|
+
disabled?: boolean;
|
|
126
|
+
/**
|
|
127
|
+
* The class of the Font Awesome icon to draw
|
|
128
|
+
*/
|
|
129
|
+
iconClass?: string;
|
|
130
|
+
/**
|
|
131
|
+
* The button's size.
|
|
132
|
+
*/
|
|
133
|
+
size?: 'small' | 'medium' | 'large' | 'x-large';
|
|
134
|
+
/**
|
|
135
|
+
* Draws an outlined button.
|
|
136
|
+
*/
|
|
137
|
+
outline?: boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Draws a circular icon button.
|
|
140
|
+
*/
|
|
141
|
+
circle?: boolean;
|
|
142
|
+
/**
|
|
143
|
+
* Make localization attributes reactive
|
|
144
|
+
*/
|
|
145
|
+
dir?: string;
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
lang?: string;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* @summary Alerts are used to display important messages inline or as toast notifications.
|
|
153
|
+
* @status stable
|
|
154
|
+
* @since 2.0
|
|
155
|
+
*
|
|
156
|
+
* @dependency cx-icon-button
|
|
157
|
+
*
|
|
158
|
+
* @slot - The alert's main content.
|
|
159
|
+
* @slot icon - An icon to show in the alert. Works best with `cx-icon`.
|
|
160
|
+
*
|
|
161
|
+
* @event cx-show - Emitted when the alert opens.
|
|
162
|
+
* @event cx-after-show - Emitted after the alert opens and all animations are complete.
|
|
163
|
+
* @event cx-hide - Emitted when the alert closes.
|
|
164
|
+
* @event cx-after-hide - Emitted after the alert closes and all animations are complete.
|
|
165
|
+
*
|
|
166
|
+
* @csspart base - The component's base wrapper.
|
|
167
|
+
* @csspart icon - The container that wraps the optional icon.
|
|
168
|
+
* @csspart message - The container that wraps the alert's main content.
|
|
169
|
+
* @csspart close-button - The close button, an `cx-icon-button`.
|
|
170
|
+
* @csspart close-button__base - The close button's exported `base` part.
|
|
171
|
+
*
|
|
172
|
+
* @animation alert.show - The animation to use when showing the alert.
|
|
173
|
+
* @animation alert.hide - The animation to use when hiding the alert.
|
|
174
|
+
*/
|
|
175
|
+
interface CxAlertAttributes extends HTMLAttributes<CxAlert> {
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can
|
|
179
|
+
* use the `show()` and `hide()` methods and this attribute will reflect the alert's open state.
|
|
180
|
+
*/
|
|
181
|
+
open?: boolean;
|
|
182
|
+
/**
|
|
183
|
+
* Enables a close button that allows the user to dismiss the alert.
|
|
184
|
+
*/
|
|
185
|
+
closable?: boolean;
|
|
186
|
+
/**
|
|
187
|
+
* The alert's theme variant.
|
|
188
|
+
*/
|
|
189
|
+
variant?: 'primary' | 'success' | 'neutral' | 'warning' | 'danger';
|
|
190
|
+
/**
|
|
191
|
+
* The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with
|
|
192
|
+
* the alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`, meaning
|
|
193
|
+
* the alert will not close on its own.
|
|
194
|
+
*/
|
|
195
|
+
duration?: number;
|
|
196
|
+
/**
|
|
197
|
+
* Enables a countdown that indicates the remaining time the alert will be displayed.
|
|
198
|
+
* Typically used to indicate the remaining time before a whole app refresh.
|
|
199
|
+
*/
|
|
200
|
+
countdown?: 'rtl' | 'ltr';
|
|
201
|
+
/**
|
|
202
|
+
* Make localization attributes reactive
|
|
203
|
+
*/
|
|
204
|
+
dir?: string;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
*/
|
|
208
|
+
lang?: string;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* @summary A component for displaying animated GIFs and WEBPs that play and pause on interaction.
|
|
212
|
+
*
|
|
213
|
+
* @dependency cx-icon
|
|
214
|
+
*
|
|
215
|
+
* @event cx-load - Emitted when the image loads successfully.
|
|
216
|
+
* @event cx-error - Emitted when the image fails to load.
|
|
217
|
+
*
|
|
218
|
+
* @slot play-icon - Optional play icon to use instead of the default. Works best with `cx-icon`.
|
|
219
|
+
* @slot pause-icon - Optional pause icon to use instead of the default. Works best with `cx-icon`.
|
|
220
|
+
*
|
|
221
|
+
* @part control-box - The container that surrounds the pause/play icons and provides their background.
|
|
222
|
+
*
|
|
223
|
+
* @cssproperty --control-box-size - The size of the icon box.
|
|
224
|
+
* @cssproperty --icon-size - The size of the play/pause icons.
|
|
225
|
+
*/
|
|
226
|
+
interface CxAnimatedImageAttributes extends HTMLAttributes<CxAnimatedImage> {
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* The path to the image to load.
|
|
230
|
+
*/
|
|
231
|
+
src?: string;
|
|
232
|
+
/**
|
|
233
|
+
* A description of the image used by assistive devices.
|
|
234
|
+
*/
|
|
235
|
+
alt?: string;
|
|
236
|
+
/**
|
|
237
|
+
* Plays the animation. When this attribute is remove, the animation will pause.
|
|
238
|
+
*/
|
|
239
|
+
play?: boolean;
|
|
240
|
+
/**
|
|
241
|
+
* Make localization attributes reactive
|
|
242
|
+
*/
|
|
243
|
+
dir?: string;
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
*/
|
|
247
|
+
lang?: string;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* @summary Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).
|
|
251
|
+
*
|
|
252
|
+
* @event cx-cancel - Emitted when the animation is canceled.
|
|
253
|
+
* @event cx-finish - Emitted when the animation finishes.
|
|
254
|
+
* @event cx-start - Emitted when the animation starts or restarts.
|
|
255
|
+
*
|
|
256
|
+
* @slot - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To
|
|
257
|
+
* animate multiple elements, either wrap them in a single container or use multiple `cx-animation` elements.
|
|
258
|
+
*/
|
|
259
|
+
interface CxAnimationAttributes extends HTMLAttributes<CxAnimation> {
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* The name of the built-in animation to use. For custom animations, use the `keyframes` prop.
|
|
263
|
+
*/
|
|
264
|
+
name?: 'easings' | 'bounce' | 'flash' | 'headShake' | 'heartBeat' | 'jello' | 'pulse' | 'rubberBand' | 'shake' | 'shakeX' | 'shakeY' | 'swing' | 'tada' | 'wobble' | 'backInDown' | 'backInLeft' | 'backInRight' | 'backInUp' | 'backOutDown' | 'backOutLeft' | 'backOutRight' | 'backOutUp' | 'bounceIn' | 'bounceInDown' | 'bounceInLeft' | 'bounceInRight' | 'bounceInUp' | 'bounceOut' | 'bounceOutDown' | 'bounceOutLeft' | 'bounceOutRight' | 'bounceOutUp' | 'fadeIn' | 'fadeInBottomLeft' | 'fadeInBottomRight' | 'fadeInDown' | 'fadeInDownBig' | 'fadeInLeft' | 'fadeInLeftBig' | 'fadeInRight' | 'fadeInRightBig' | 'fadeInTopLeft' | 'fadeInTopRight' | 'fadeInUp' | 'fadeInUpBig' | 'fadeOut' | 'fadeOutBottomLeft' | 'fadeOutBottomRight' | 'fadeOutDown' | 'fadeOutDownBig' | 'fadeOutLeft' | 'fadeOutLeftBig' | 'fadeOutRight' | 'fadeOutRightBig' | 'fadeOutTopLeft' | 'fadeOutTopRight' | 'fadeOutUp' | 'fadeOutUpBig' | 'flip' | 'flipInX' | 'flipInY' | 'flipOutX' | 'flipOutY' | 'lightSpeedInLeft' | 'lightSpeedInRight' | 'lightSpeedOutLeft' | 'lightSpeedOutRight' | 'rotateIn' | 'rotateInDownLeft' | 'rotateInDownRight' | 'rotateInUpLeft' | 'rotateInUpRight' | 'rotateOut' | 'rotateOutDownLeft' | 'rotateOutDownRight' | 'rotateOutUpLeft' | 'rotateOutUpRight' | 'slideInDown' | 'slideInLeft' | 'slideInRight' | 'slideInUp' | 'slideOutDown' | 'slideOutLeft' | 'slideOutRight' | 'slideOutUp' | 'hinge' | 'jackInTheBox' | 'rollIn' | 'rollOut' | 'zoomIn' | 'zoomInDown' | 'zoomInLeft' | 'zoomInRight' | 'zoomInUp' | 'zoomOut' | 'zoomOutDown' | 'zoomOutLeft' | 'zoomOutRight' | 'zoomOutUp' | 'none' | string;
|
|
265
|
+
/**
|
|
266
|
+
* Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when
|
|
267
|
+
* the animation finishes or gets canceled.
|
|
268
|
+
*/
|
|
269
|
+
play?: boolean;
|
|
270
|
+
/**
|
|
271
|
+
* The number of milliseconds to delay the start of the animation.
|
|
272
|
+
*/
|
|
273
|
+
delay?: number;
|
|
274
|
+
/**
|
|
275
|
+
* Determines the direction of playback as well as the behavior when reaching the end of an iteration.
|
|
276
|
+
* [Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)
|
|
277
|
+
*/
|
|
278
|
+
direction?: 'alternate' | 'alternate-reverse' | 'normal' | 'reverse';
|
|
279
|
+
/**
|
|
280
|
+
* The number of milliseconds each iteration of the animation takes to complete.
|
|
281
|
+
*/
|
|
282
|
+
duration?: number;
|
|
283
|
+
/**
|
|
284
|
+
* The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function
|
|
285
|
+
* such as `cubic-bezier(0, 1, .76, 1.14)`.
|
|
286
|
+
*/
|
|
287
|
+
easing?: 'ease' | 'linear' | 'easeIn' | 'easeInBack' | 'easeInCirc' | 'easeInCubic' | 'easeInExpo' | 'easeInOut' | 'easeInOutBack' | 'easeInOutCirc' | 'easeInOutCubic' | 'easeInOutExpo' | 'easeInOutQuad' | 'easeInOutQuart' | 'easeInOutQuint' | 'easeInOutSine' | 'easeInQuad' | 'easeInQuart' | 'easeInQuint' | 'easeInSine' | 'easeOut' | 'easeOutBack' | 'easeOutCirc' | 'easeOutCubic' | 'easeOutExpo' | 'easeOutQuad' | 'easeOutQuart' | 'easeOutQuint' | 'easeOutSine' | string;
|
|
288
|
+
/**
|
|
289
|
+
* The number of milliseconds to delay after the active period of an animation sequence.
|
|
290
|
+
*/
|
|
291
|
+
endDelay?: number;
|
|
292
|
+
/**
|
|
293
|
+
* Sets how the animation applies styles to its target before and after its execution.
|
|
294
|
+
*/
|
|
295
|
+
fill?: 'none' | 'auto' | 'backwards' | 'both' | 'forwards';
|
|
296
|
+
/**
|
|
297
|
+
* The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.
|
|
298
|
+
*/
|
|
299
|
+
iterations?: number;
|
|
300
|
+
/**
|
|
301
|
+
* The offset at which to start the animation, usually between 0 (start) and 1 (end).
|
|
302
|
+
*/
|
|
303
|
+
iterationStart?: number;
|
|
304
|
+
/**
|
|
305
|
+
* The keyframes to use for the animation. If this is set, `name` will be ignored.
|
|
306
|
+
*/
|
|
307
|
+
keyframes?: { composite: 'auto' | 'accumulate' | 'add' | 'replace'; easing: string; offset: number; }[];
|
|
308
|
+
/**
|
|
309
|
+
* Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this
|
|
310
|
+
* to `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This
|
|
311
|
+
* value can be changed without causing the animation to restart.
|
|
312
|
+
*/
|
|
313
|
+
playbackRate?: number;
|
|
314
|
+
/**
|
|
315
|
+
* Make localization attributes reactive
|
|
316
|
+
*/
|
|
317
|
+
dir?: string;
|
|
318
|
+
/**
|
|
319
|
+
*
|
|
320
|
+
*/
|
|
321
|
+
lang?: string;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* @summary Avatars are used to represent a person or object.
|
|
325
|
+
*
|
|
326
|
+
* @dependency cx-icon
|
|
327
|
+
*
|
|
328
|
+
* @event cx-error - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some
|
|
329
|
+
* unknown cause.
|
|
330
|
+
*
|
|
331
|
+
* @slot icon - The default icon to use when no image or initials are present. Works best with `cx-icon`.
|
|
332
|
+
*
|
|
333
|
+
* @csspart base - The component's base wrapper.
|
|
334
|
+
* @csspart icon - The container that wraps the avatar's icon.
|
|
335
|
+
* @csspart initials - The container that wraps the avatar's initials.
|
|
336
|
+
* @csspart image - The avatar image. Only shown when the `image` attribute is set.
|
|
337
|
+
*
|
|
338
|
+
* @cssproperty --size - The size of the avatar.
|
|
339
|
+
*/
|
|
340
|
+
interface CxAvatarAttributes extends HTMLAttributes<CxAvatar> {
|
|
341
|
+
|
|
342
|
+
/**
|
|
343
|
+
* The image source to use for the avatar.
|
|
344
|
+
*/
|
|
345
|
+
image?: string;
|
|
346
|
+
/**
|
|
347
|
+
* A label to use to describe the avatar to assistive devices.
|
|
348
|
+
*/
|
|
349
|
+
label?: string;
|
|
350
|
+
/**
|
|
351
|
+
* Initials to use as a fallback when no image is available (1-2 characters max recommended).
|
|
352
|
+
*/
|
|
353
|
+
initials?: string;
|
|
354
|
+
/**
|
|
355
|
+
* Indicates how the browser should load the image.
|
|
356
|
+
*/
|
|
357
|
+
loading?: 'eager' | 'lazy';
|
|
358
|
+
/**
|
|
359
|
+
* The shape of the avatar.
|
|
360
|
+
*/
|
|
361
|
+
shape?: 'circle' | 'rounded' | 'square';
|
|
362
|
+
/**
|
|
363
|
+
* Make localization attributes reactive
|
|
364
|
+
*/
|
|
365
|
+
dir?: string;
|
|
366
|
+
/**
|
|
367
|
+
*
|
|
368
|
+
*/
|
|
369
|
+
lang?: string;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* @summary Badges are used to draw attention and display statuses or counts.
|
|
373
|
+
*
|
|
374
|
+
* @slot - The badge's content.
|
|
375
|
+
*
|
|
376
|
+
* @csspart base - The component's base wrapper.
|
|
377
|
+
*/
|
|
378
|
+
interface CxBadgeAttributes extends HTMLAttributes<CxBadge> {
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* The badge's theme variant.
|
|
382
|
+
*/
|
|
383
|
+
variant?: 'primary' | 'success' | 'neutral' | 'warning' | 'danger';
|
|
384
|
+
/**
|
|
385
|
+
* Draws a pill-style badge with rounded edges.
|
|
386
|
+
*/
|
|
387
|
+
pill?: boolean;
|
|
388
|
+
/**
|
|
389
|
+
* Makes the badge pulsate to draw attention.
|
|
390
|
+
*/
|
|
391
|
+
pulse?: boolean;
|
|
392
|
+
/**
|
|
393
|
+
* Make localization attributes reactive
|
|
394
|
+
*/
|
|
395
|
+
dir?: string;
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
*/
|
|
399
|
+
lang?: string;
|
|
400
|
+
}
|
|
401
|
+
/**
|
|
402
|
+
* @summary Breadcrumb Items are used inside [breadcrumbs](?s=atoms&id=/breadcrumb) to represent different links.
|
|
403
|
+
*
|
|
404
|
+
* @slot - The breadcrumb item's label.
|
|
405
|
+
* @slot prefix - An optional prefix, usually an icon or icon button.
|
|
406
|
+
* @slot suffix - An optional suffix, usually an icon or icon button.
|
|
407
|
+
* @slot separator - The separator to use for the breadcrumb item. This will only change the separator for this item. If
|
|
408
|
+
* you want to change it for all items in the group, set the separator on `cx-breadcrumb` instead.
|
|
409
|
+
*
|
|
410
|
+
* @csspart base - The component's base wrapper.
|
|
411
|
+
* @csspart label - The breadcrumb item's label.
|
|
412
|
+
* @csspart prefix - The container that wraps the prefix.
|
|
413
|
+
* @csspart suffix - The container that wraps the suffix.
|
|
414
|
+
* @csspart separator - The container that wraps the separator.
|
|
415
|
+
*/
|
|
416
|
+
interface CxBreadcrumbItemAttributes extends HTMLAttributes<CxBreadcrumbItem> {
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered
|
|
420
|
+
* internally. When unset, a button will be rendered instead.
|
|
421
|
+
*/
|
|
422
|
+
href?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Tells the browser where to open the link. Only used when `href` is set.
|
|
425
|
+
*/
|
|
426
|
+
target?: '_blank' | '_parent' | '_self' | '_top';
|
|
427
|
+
/**
|
|
428
|
+
* The `rel` attribute to use on the link. Only used when `href` is set.
|
|
429
|
+
*/
|
|
430
|
+
rel?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Make localization attributes reactive
|
|
433
|
+
*/
|
|
434
|
+
dir?: string;
|
|
435
|
+
/**
|
|
436
|
+
*
|
|
437
|
+
*/
|
|
438
|
+
lang?: string;
|
|
439
|
+
}
|
|
440
|
+
/**
|
|
441
|
+
* @summary Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.
|
|
442
|
+
*
|
|
443
|
+
* @slot - One or more breadcrumb items to display.
|
|
444
|
+
* @slot separator - The separator to use between breadcrumb items. Works best with `cx-icon`.
|
|
445
|
+
*
|
|
446
|
+
* @dependency cx-icon
|
|
447
|
+
*
|
|
448
|
+
* @csspart base - The component's base wrapper.
|
|
449
|
+
*/
|
|
450
|
+
interface CxBreadcrumbAttributes extends HTMLAttributes<CxBreadcrumb> {
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by
|
|
454
|
+
* screen readers and other assistive devices to provide more context for users.
|
|
455
|
+
*/
|
|
456
|
+
label?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Make localization attributes reactive
|
|
459
|
+
*/
|
|
460
|
+
dir?: string;
|
|
461
|
+
/**
|
|
462
|
+
*
|
|
463
|
+
*/
|
|
464
|
+
lang?: string;
|
|
465
|
+
}
|
|
466
|
+
/**
|
|
467
|
+
* @summary Spinners are used to show the progress of an indeterminate operation.
|
|
468
|
+
*
|
|
469
|
+
* @csspart base - The component's base wrapper.
|
|
470
|
+
*
|
|
471
|
+
* @cssproperty --track-width - The width of the track.
|
|
472
|
+
* @cssproperty --track-color - The color of the track.
|
|
473
|
+
* @cssproperty --indicator-color - The color of the spinner's indicator.
|
|
474
|
+
* @cssproperty --speed - The time it takes for the spinner to complete one animation cycle.
|
|
475
|
+
*/
|
|
476
|
+
interface CxSpinnerAttributes extends HTMLAttributes<CxSpinner> {
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* Make localization attributes reactive
|
|
480
|
+
*/
|
|
481
|
+
dir?: string;
|
|
482
|
+
/**
|
|
483
|
+
*
|
|
484
|
+
*/
|
|
485
|
+
lang?: string;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* @summary Buttons represent actions that are available to the user.
|
|
489
|
+
*
|
|
490
|
+
* @dependency cx-icon
|
|
491
|
+
* @dependency cx-spinner
|
|
492
|
+
*
|
|
493
|
+
* @event cx-blur - Emitted when the button loses focus.
|
|
494
|
+
* @event cx-focus - Emitted when the button gains focus.
|
|
495
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
496
|
+
*
|
|
497
|
+
* @slot - The button's label.
|
|
498
|
+
* @slot prefix - A presentational prefix icon or similar element.
|
|
499
|
+
* @slot suffix - A presentational suffix icon or similar element.
|
|
500
|
+
*
|
|
501
|
+
* @csspart base - The component's base wrapper.
|
|
502
|
+
* @csspart prefix - The container that wraps the prefix.
|
|
503
|
+
* @csspart label - The button's label.
|
|
504
|
+
* @csspart suffix - The container that wraps the suffix.
|
|
505
|
+
* @csspart caret - The button's caret icon, an `cx-icon` element.
|
|
506
|
+
* @csspart spinner - The spinner that shows when the button is in the loading state.
|
|
507
|
+
*/
|
|
508
|
+
interface CxButtonAttributes extends HTMLAttributes<CxButton> {
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
*
|
|
512
|
+
*/
|
|
513
|
+
title?: string;
|
|
514
|
+
/**
|
|
515
|
+
* make reactive to pass through The button's theme variant.
|
|
516
|
+
*/
|
|
517
|
+
variant?: 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'default' | 'text' | 'tertiary';
|
|
518
|
+
/**
|
|
519
|
+
* The button's size.
|
|
520
|
+
*/
|
|
521
|
+
size?: 'small' | 'medium' | 'large' | 'x-large';
|
|
522
|
+
/**
|
|
523
|
+
* Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.
|
|
524
|
+
*/
|
|
525
|
+
caret?: boolean;
|
|
526
|
+
/**
|
|
527
|
+
* Disables the button.
|
|
528
|
+
*/
|
|
529
|
+
disabled?: boolean;
|
|
530
|
+
/**
|
|
531
|
+
* Draws the button in a loading state.
|
|
532
|
+
*/
|
|
533
|
+
loading?: boolean;
|
|
534
|
+
/**
|
|
535
|
+
* Draws an outlined button.
|
|
536
|
+
*/
|
|
537
|
+
outline?: boolean;
|
|
538
|
+
/**
|
|
539
|
+
* Draws a pill-style button with rounded edges.
|
|
540
|
+
*/
|
|
541
|
+
pill?: boolean;
|
|
542
|
+
/**
|
|
543
|
+
* Draws a circular icon button. When this attribute is present, the button expects a single `cx-icon` in the
|
|
544
|
+
* default slot.
|
|
545
|
+
*/
|
|
546
|
+
circle?: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native
|
|
549
|
+
* `button` elements behave. When the type is `submit`, the button will submit the surrounding form.
|
|
550
|
+
*/
|
|
551
|
+
type?: 'reset' | 'submit' | 'button';
|
|
552
|
+
/**
|
|
553
|
+
* The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.
|
|
554
|
+
* This attribute is ignored when `href` is present.
|
|
555
|
+
*/
|
|
556
|
+
name?: string;
|
|
557
|
+
/**
|
|
558
|
+
* The value of the button, submitted as a pair with the button's name as part of the form data, but only when this
|
|
559
|
+
* button is the submitter. This attribute is ignored when `href` is present.
|
|
560
|
+
*/
|
|
561
|
+
value?: string;
|
|
562
|
+
/**
|
|
563
|
+
* When set, the underlying button will be rendered as an `a` with this `href` instead of a `button`.
|
|
564
|
+
*/
|
|
565
|
+
href?: string;
|
|
566
|
+
/**
|
|
567
|
+
* Tells the browser where to open the link. Only used when `href` is present.
|
|
568
|
+
*/
|
|
569
|
+
target?: '_blank' | '_parent' | '_self' | '_top';
|
|
570
|
+
/**
|
|
571
|
+
* When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the
|
|
572
|
+
* default is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a
|
|
573
|
+
* specific tab/window, this will prevent that from working correctly. You can remove or change the default value by
|
|
574
|
+
* setting the attribute to an empty string or a value of your choice, respectively.
|
|
575
|
+
*/
|
|
576
|
+
rel?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Tells the browser to download the linked file as this filename. Only used when `href` is present.
|
|
579
|
+
*/
|
|
580
|
+
download?: string;
|
|
581
|
+
/**
|
|
582
|
+
* The "form owner" to associate the button with. If omitted, the closest containing form will be used instead. The
|
|
583
|
+
* value of this attribute must be an id of a form in the same document or shadow root as the button.
|
|
584
|
+
*/
|
|
585
|
+
form?: string;
|
|
586
|
+
/**
|
|
587
|
+
* Used to override the form owner's `action` attribute.
|
|
588
|
+
*/
|
|
589
|
+
formaction?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Used to override the form owner's `enctype` attribute.
|
|
592
|
+
*/
|
|
593
|
+
formenctype?: 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain';
|
|
594
|
+
/**
|
|
595
|
+
* Used to override the form owner's `method` attribute.
|
|
596
|
+
*/
|
|
597
|
+
formmethod?: 'post' | 'get';
|
|
598
|
+
/**
|
|
599
|
+
* Used to override the form owner's `novalidate` attribute.
|
|
600
|
+
*/
|
|
601
|
+
formnovalidate?: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* Used to override the form owner's `target` attribute.
|
|
604
|
+
*/
|
|
605
|
+
formtarget?: string;
|
|
606
|
+
/**
|
|
607
|
+
* Make localization attributes reactive
|
|
608
|
+
*/
|
|
609
|
+
dir?: string;
|
|
610
|
+
/**
|
|
611
|
+
*
|
|
612
|
+
*/
|
|
613
|
+
lang?: string;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
* @summary Button groups can be used to group related buttons into sections.
|
|
617
|
+
*
|
|
618
|
+
* @slot - One or more `cx-button` elements to display in the button group.
|
|
619
|
+
*
|
|
620
|
+
* @csspart base - The component's base wrapper.
|
|
621
|
+
*/
|
|
622
|
+
interface CxButtonGroupAttributes extends HTMLAttributes<CxButtonGroup> {
|
|
623
|
+
|
|
624
|
+
/**
|
|
625
|
+
* A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive
|
|
626
|
+
* devices when interacting with the control and is strongly recommended.
|
|
627
|
+
*/
|
|
628
|
+
label?: string;
|
|
629
|
+
/**
|
|
630
|
+
* Make localization attributes reactive
|
|
631
|
+
*/
|
|
632
|
+
dir?: string;
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
*/
|
|
636
|
+
lang?: string;
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* @summary Cards can be used to group related subjects in a container.
|
|
640
|
+
*
|
|
641
|
+
* @slot - The card's main content.
|
|
642
|
+
* @slot header - An optional header for the card.
|
|
643
|
+
* @slot footer - An optional footer for the card.
|
|
644
|
+
* @slot image - An optional image to render at the start of the card.
|
|
645
|
+
*
|
|
646
|
+
* @csspart base - The component's base wrapper.
|
|
647
|
+
* @csspart image - The container that wraps the card's image.
|
|
648
|
+
* @csspart header - The container that wraps the card's header.
|
|
649
|
+
* @csspart body - The container that wraps the card's main content.
|
|
650
|
+
* @csspart footer - The container that wraps the card's footer.
|
|
651
|
+
*
|
|
652
|
+
* @cssproperty --border-color - The card's border color, including borders that occur inside the card.
|
|
653
|
+
* @cssproperty --border-radius - The border radius for the card's edges.
|
|
654
|
+
* @cssproperty --border-width - The width of the card's borders.
|
|
655
|
+
* @cssproperty --padding - The padding to use for the card's sections.
|
|
656
|
+
*/
|
|
657
|
+
interface CxCardAttributes extends HTMLAttributes<CxCard> {
|
|
658
|
+
|
|
659
|
+
/**
|
|
660
|
+
* Draws the option in an interactive state.
|
|
661
|
+
*/
|
|
662
|
+
interactive?: boolean;
|
|
663
|
+
/**
|
|
664
|
+
* Make localization attributes reactive
|
|
665
|
+
*/
|
|
666
|
+
dir?: string;
|
|
667
|
+
/**
|
|
668
|
+
*
|
|
669
|
+
*/
|
|
670
|
+
lang?: string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* @summary A carousel item represent a slide within a [carousel](?s=atoms&id=/carousel).
|
|
674
|
+
*
|
|
675
|
+
* @since 2.0
|
|
676
|
+
* @status experimental
|
|
677
|
+
*
|
|
678
|
+
* @slot - The carousel item's content..
|
|
679
|
+
*
|
|
680
|
+
* @cssproperty --aspect-ratio - The slide's aspect ratio. Inherited from the carousel by default.
|
|
681
|
+
*/
|
|
682
|
+
interface CxCarouselItemAttributes extends HTMLAttributes<CxCarouselItem> {
|
|
683
|
+
|
|
684
|
+
/**
|
|
685
|
+
* Make localization attributes reactive
|
|
686
|
+
*/
|
|
687
|
+
dir?: string;
|
|
688
|
+
/**
|
|
689
|
+
*
|
|
690
|
+
*/
|
|
691
|
+
lang?: string;
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* @summary Carousels display an arbitrary number of content slides along a horizontal or vertical axis.
|
|
695
|
+
*
|
|
696
|
+
* @since 2.2
|
|
697
|
+
* @status experimental
|
|
698
|
+
*
|
|
699
|
+
* @dependency cx-icon
|
|
700
|
+
*
|
|
701
|
+
* @event {{ index: number, slide: CxCarouselItem }} cx-slide-change - Emitted when the active slide changes.
|
|
702
|
+
*
|
|
703
|
+
* @slot - The carousel's main content, one or more `cx-carousel-item` elements.
|
|
704
|
+
* @slot next-icon - Optional next icon to use instead of the default. Works best with `cx-icon`.
|
|
705
|
+
* @slot previous-icon - Optional previous icon to use instead of the default. Works best with `cx-icon`.
|
|
706
|
+
*
|
|
707
|
+
* @csspart base - The carousel's internal wrapper.
|
|
708
|
+
* @csspart scroll-container - The scroll container that wraps the slides.
|
|
709
|
+
* @csspart pagination - The pagination indicators wrapper.
|
|
710
|
+
* @csspart pagination-item - The pagination indicator.
|
|
711
|
+
* @csspart pagination-item--active - Applied when the item is active.
|
|
712
|
+
* @csspart navigation - The navigation wrapper.
|
|
713
|
+
* @csspart navigation-button - The navigation button.
|
|
714
|
+
* @csspart navigation-button--previous - Applied to the previous button.
|
|
715
|
+
* @csspart navigation-button--next - Applied to the next button.
|
|
716
|
+
*
|
|
717
|
+
* @cssproperty --slide-gap - The space between each slide.
|
|
718
|
+
* @cssproperty [--aspect-ratio=16/9] - The aspect ratio of each slide.
|
|
719
|
+
* @cssproperty --scroll-hint - The amount of padding to apply to the scroll area, allowing adjacent slides to become
|
|
720
|
+
* partially visible as a scroll hint.
|
|
721
|
+
*/
|
|
722
|
+
interface CxCarouselAttributes extends HTMLAttributes<CxCarousel> {
|
|
723
|
+
|
|
724
|
+
/**
|
|
725
|
+
* When set, allows the user to navigate the carousel in the same direction indefinitely.
|
|
726
|
+
*/
|
|
727
|
+
loop?: boolean;
|
|
728
|
+
/**
|
|
729
|
+
* When set, show the carousel's navigation.
|
|
730
|
+
*/
|
|
731
|
+
navigation?: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* When set, show the carousel's pagination indicators.
|
|
734
|
+
*/
|
|
735
|
+
pagination?: boolean;
|
|
736
|
+
/**
|
|
737
|
+
* When set, the slides will scroll automatically when the user is not interacting with them.
|
|
738
|
+
*/
|
|
739
|
+
autoplay?: boolean;
|
|
740
|
+
/**
|
|
741
|
+
* Specifies the amount of time, in milliseconds, between each automatic scroll.
|
|
742
|
+
*/
|
|
743
|
+
autoplayInterval?: number;
|
|
744
|
+
/**
|
|
745
|
+
* Specifies how many slides should be shown at a given time.
|
|
746
|
+
*/
|
|
747
|
+
slidesPerPage?: number;
|
|
748
|
+
/**
|
|
749
|
+
* Specifies the number of slides the carousel will advance when scrolling, useful when specifying a `slides-per-page`
|
|
750
|
+
* greater than one. It can't be higher than `slides-per-page`.
|
|
751
|
+
*/
|
|
752
|
+
slidesPerMove?: number;
|
|
753
|
+
/**
|
|
754
|
+
* Specifies the orientation in which the carousel will lay out.
|
|
755
|
+
*/
|
|
756
|
+
orientation?: 'horizontal' | 'vertical';
|
|
757
|
+
/**
|
|
758
|
+
* When set, it is possible to scroll through the slides by dragging them with the mouse.
|
|
759
|
+
*/
|
|
760
|
+
mouseDragging?: boolean;
|
|
761
|
+
/**
|
|
762
|
+
* Make localization attributes reactive
|
|
763
|
+
*/
|
|
764
|
+
dir?: string;
|
|
765
|
+
/**
|
|
766
|
+
*
|
|
767
|
+
*/
|
|
768
|
+
lang?: string;
|
|
769
|
+
}
|
|
770
|
+
/**
|
|
771
|
+
* @summary Popup is a utility that lets you declaratively anchor "popup" containers to another element.
|
|
772
|
+
*
|
|
773
|
+
* @event cx-reposition - Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive
|
|
774
|
+
* operations in your listener or consider debouncing it.
|
|
775
|
+
*
|
|
776
|
+
* @slot - The popup's content.
|
|
777
|
+
* @slot anchor - The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the
|
|
778
|
+
* `anchor` attribute or property instead.
|
|
779
|
+
*
|
|
780
|
+
* @csspart arrow - The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are
|
|
781
|
+
* assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and
|
|
782
|
+
* maybe a border or box shadow.
|
|
783
|
+
* @csspart popup - The popup's container. Useful for setting a background color, box shadow, etc.
|
|
784
|
+
* @csspart hover-bridge - The hover bridge element. Only available when the `hover-bridge` option is enabled.
|
|
785
|
+
*
|
|
786
|
+
* @cssproperty [--arrow-size=6px] - The size of the arrow. Note that an arrow won't be shown unless the `arrow`
|
|
787
|
+
* attribute is used.
|
|
788
|
+
* @cssproperty [--arrow-color=var(--cx-color-neutral-0)] - The color of the arrow.
|
|
789
|
+
* @cssproperty [--auto-size-available-width] - A read-only custom property that determines the amount of width the
|
|
790
|
+
* popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only
|
|
791
|
+
* available when using `auto-size`.
|
|
792
|
+
* @cssproperty [--auto-size-available-height] - A read-only custom property that determines the amount of height the
|
|
793
|
+
* popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only
|
|
794
|
+
* available when using `auto-size`.
|
|
795
|
+
*/
|
|
796
|
+
interface CxPopupAttributes extends HTMLAttributes<CxPopup> {
|
|
797
|
+
|
|
798
|
+
/**
|
|
799
|
+
* The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor
|
|
800
|
+
* element `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the
|
|
801
|
+
* `anchor` slot instead.
|
|
802
|
+
*/
|
|
803
|
+
anchor?: string;
|
|
804
|
+
/**
|
|
805
|
+
* Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn
|
|
806
|
+
* down and the popup will be hidden.
|
|
807
|
+
*/
|
|
808
|
+
active?: boolean;
|
|
809
|
+
/**
|
|
810
|
+
* The preferred placement of the popup. Note that the actual placement will vary as configured to keep the
|
|
811
|
+
* panel inside of the viewport.
|
|
812
|
+
*/
|
|
813
|
+
placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';
|
|
814
|
+
/**
|
|
815
|
+
* Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is
|
|
816
|
+
* clipped, using a `fixed` position strategy can often workaround it.
|
|
817
|
+
*/
|
|
818
|
+
strategy?: 'absolute' | 'fixed';
|
|
819
|
+
/**
|
|
820
|
+
* The distance in pixels from which to offset the panel away from its anchor.
|
|
821
|
+
*/
|
|
822
|
+
distance?: number;
|
|
823
|
+
/**
|
|
824
|
+
* The distance in pixels from which to offset the panel along its anchor.
|
|
825
|
+
*/
|
|
826
|
+
skidding?: number;
|
|
827
|
+
/**
|
|
828
|
+
* Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and
|
|
829
|
+
* `--arrow-color` custom properties. For additional customizations, you can also target the arrow using
|
|
830
|
+
* `::part(arrow)` in your stylesheet.
|
|
831
|
+
*/
|
|
832
|
+
arrow?: boolean;
|
|
833
|
+
/**
|
|
834
|
+
* The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the
|
|
835
|
+
* anchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will
|
|
836
|
+
* align the arrow to the start, end, or center of the popover instead.
|
|
837
|
+
*/
|
|
838
|
+
arrowPlacement?: 'center' | 'start' | 'end' | 'anchor';
|
|
839
|
+
/**
|
|
840
|
+
* The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,
|
|
841
|
+
* this will prevent it from overflowing the corners.
|
|
842
|
+
*/
|
|
843
|
+
arrowPadding?: number;
|
|
844
|
+
/**
|
|
845
|
+
* When set, placement of the popup will flip to the opposite site to keep it in view. You can use
|
|
846
|
+
* `flipFallbackPlacements` to further configure how the fallback placement is determined.
|
|
847
|
+
*/
|
|
848
|
+
flip?: boolean;
|
|
849
|
+
/**
|
|
850
|
+
* If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a
|
|
851
|
+
* string of any number of placements separated by a space, e.g. "top bottom left". If no placement fits, the flip
|
|
852
|
+
* fallback strategy will be used instead.
|
|
853
|
+
*/
|
|
854
|
+
flipFallbackPlacements?: string;
|
|
855
|
+
/**
|
|
856
|
+
* When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether
|
|
857
|
+
* the popup should be positioned using the best available fit based on available space or as it was initially
|
|
858
|
+
* preferred.
|
|
859
|
+
*/
|
|
860
|
+
flipFallbackStrategy?: 'best-fit' | 'initial';
|
|
861
|
+
/**
|
|
862
|
+
* The amount of padding, in pixels, to exceed before the flip behavior will occur.
|
|
863
|
+
*/
|
|
864
|
+
flipPadding?: number;
|
|
865
|
+
/**
|
|
866
|
+
* Moves the popup along the axis to keep it in view when clipped.
|
|
867
|
+
*/
|
|
868
|
+
shift?: boolean;
|
|
869
|
+
/**
|
|
870
|
+
* The amount of padding, in pixels, to exceed before the shift behavior will occur.
|
|
871
|
+
*/
|
|
872
|
+
shiftPadding?: number;
|
|
873
|
+
/**
|
|
874
|
+
* When set, this will cause the popup to automatically resize itself to prevent it from overflowing.
|
|
875
|
+
*/
|
|
876
|
+
autoSize?: 'both' | 'horizontal' | 'vertical';
|
|
877
|
+
/**
|
|
878
|
+
* Syncs the popup's width or height to that of the anchor element.
|
|
879
|
+
*/
|
|
880
|
+
sync?: 'both' | 'width' | 'height';
|
|
881
|
+
/**
|
|
882
|
+
* The amount of padding, in pixels, to exceed before the auto-size behavior will occur.
|
|
883
|
+
*/
|
|
884
|
+
autoSizePadding?: number;
|
|
885
|
+
/**
|
|
886
|
+
* When a gap exists between the anchor and the popup element, this option will add a "hover bridge" that fills the
|
|
887
|
+
* gap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane
|
|
888
|
+
* because the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is
|
|
889
|
+
* active.
|
|
890
|
+
*/
|
|
891
|
+
hoverBridge?: boolean;
|
|
892
|
+
/**
|
|
893
|
+
* The factor by which to multiply the available width when using `auto-size`. E.g: Set to 0.5 to
|
|
894
|
+
* make the popup half the width of the available space.
|
|
895
|
+
*/
|
|
896
|
+
autoWidthFactor?: number;
|
|
897
|
+
/**
|
|
898
|
+
* Make localization attributes reactive
|
|
899
|
+
*/
|
|
900
|
+
dir?: string;
|
|
901
|
+
/**
|
|
902
|
+
*
|
|
903
|
+
*/
|
|
904
|
+
lang?: string;
|
|
905
|
+
}
|
|
906
|
+
/**
|
|
907
|
+
* @summary Tooltips display additional information based on a specific action.
|
|
908
|
+
*
|
|
909
|
+
* @dependency cx-popup
|
|
910
|
+
*
|
|
911
|
+
* @slot - The tooltip's target element. Avoid slotting in more than one element, as subsequent ones will be ignored.
|
|
912
|
+
* @slot content - The content to render in the tooltip. Alternatively, you can use the `content` attribute.
|
|
913
|
+
*
|
|
914
|
+
* @event cx-show - Emitted when the tooltip begins to show.
|
|
915
|
+
* @event cx-after-show - Emitted after the tooltip has shown and all animations are complete.
|
|
916
|
+
* @event cx-hide - Emitted when the tooltip begins to hide.
|
|
917
|
+
* @event cx-after-hide - Emitted after the tooltip has hidden and all animations are complete.
|
|
918
|
+
*
|
|
919
|
+
* @csspart base - The component's base wrapper, an `cx-popup` element.
|
|
920
|
+
* @csspart base__popup - The popup's exported `popup` part. Use this to target the tooltip's popup container.
|
|
921
|
+
* @csspart base__arrow - The popup's exported `arrow` part. Use this to target the tooltip's arrow.
|
|
922
|
+
* @csspart body - The tooltip's body where its content is rendered.
|
|
923
|
+
* @csspart hover-bridge - The hover bridge element. Only available when the `hover-bridge` option is enabled.
|
|
924
|
+
* @cssproperty --max-width - The maximum width of the tooltip before its content will wrap.
|
|
925
|
+
* @cssproperty --hide-delay - The amount of time to wait before hiding the tooltip when hovering.
|
|
926
|
+
* @cssproperty --show-delay - The amount of time to wait before showing the tooltip when hovering.
|
|
927
|
+
*
|
|
928
|
+
* @animation tooltip.show - The animation to use when showing the tooltip.
|
|
929
|
+
* @animation tooltip.hide - The animation to use when hiding the tooltip.
|
|
930
|
+
*/
|
|
931
|
+
interface CxTooltipAttributes extends HTMLAttributes<CxTooltip> {
|
|
932
|
+
|
|
933
|
+
/**
|
|
934
|
+
* The tooltip's content. If you need to display HTML, use the `content` slot instead.
|
|
935
|
+
*/
|
|
936
|
+
content?: string;
|
|
937
|
+
/**
|
|
938
|
+
* The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip
|
|
939
|
+
* inside of the viewport.
|
|
940
|
+
*/
|
|
941
|
+
placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';
|
|
942
|
+
/**
|
|
943
|
+
* Disables the tooltip so it won't show when triggered.
|
|
944
|
+
*/
|
|
945
|
+
disabled?: boolean;
|
|
946
|
+
/**
|
|
947
|
+
* The distance in pixels from which to offset the tooltip away from its target.
|
|
948
|
+
*/
|
|
949
|
+
distance?: number;
|
|
950
|
+
/**
|
|
951
|
+
* Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.
|
|
952
|
+
*/
|
|
953
|
+
open?: boolean;
|
|
954
|
+
/**
|
|
955
|
+
* The distance in pixels from which to offset the tooltip along its target.
|
|
956
|
+
*/
|
|
957
|
+
skidding?: number;
|
|
958
|
+
/**
|
|
959
|
+
* Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple
|
|
960
|
+
* options can be passed by separating them with a space. When manual is used, the tooltip must be activated
|
|
961
|
+
* programmatically.
|
|
962
|
+
*/
|
|
963
|
+
trigger?: string;
|
|
964
|
+
/**
|
|
965
|
+
* Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with
|
|
966
|
+
* `overflow: auto|hidden|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all,
|
|
967
|
+
* scenarios.
|
|
968
|
+
*/
|
|
969
|
+
hoist?: boolean;
|
|
970
|
+
/**
|
|
971
|
+
* When a gap exists between the anchor and the popup element, this option will add a "hover bridge" that fills the
|
|
972
|
+
* gap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane
|
|
973
|
+
* because the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is
|
|
974
|
+
* active.
|
|
975
|
+
*/
|
|
976
|
+
hoverBridge?: boolean;
|
|
977
|
+
/**
|
|
978
|
+
* Make localization attributes reactive
|
|
979
|
+
*/
|
|
980
|
+
dir?: string;
|
|
981
|
+
/**
|
|
982
|
+
*
|
|
983
|
+
*/
|
|
984
|
+
lang?: string;
|
|
985
|
+
}
|
|
986
|
+
/**
|
|
987
|
+
* @summary Renders markdown passed in as a string. cx-markdown is a Light DOM element, so can be styled
|
|
988
|
+
* from outside the Shadow DOM.
|
|
989
|
+
*
|
|
990
|
+
* @event cx-ready - Emitted when the markdown has been rendered.
|
|
991
|
+
*/
|
|
992
|
+
interface CxMarkdownAttributes extends HTMLAttributes<CxMarkdown> {
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* The class name to apply to the root element. As this is a light DOM element, it can be styled
|
|
996
|
+
* from outside the Shadow DOM.
|
|
997
|
+
*/
|
|
998
|
+
classname?: string;
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
*/
|
|
1002
|
+
liveScript?: boolean;
|
|
1003
|
+
/**
|
|
1004
|
+
* The markdown to render.
|
|
1005
|
+
*/
|
|
1006
|
+
markdown?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* A marked renderer object to use when rendering the markdown. This overrides the current renderer
|
|
1009
|
+
* only for those methods that are specifically defined on the passed in renderer object.
|
|
1010
|
+
*/
|
|
1011
|
+
renderer?: CxMarkdownRendererObject;
|
|
1012
|
+
/**
|
|
1013
|
+
* Extensions to add to the marked parser.
|
|
1014
|
+
*/
|
|
1015
|
+
extensions?: { name: string; level: 'block' | 'inline'; childTokens: string[]; } | { name: string; } | { name: string; level: 'block' | 'inline'; childTokens: string[]; }[];
|
|
1016
|
+
/**
|
|
1017
|
+
* Make localization attributes reactive
|
|
1018
|
+
*/
|
|
1019
|
+
dir?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
*
|
|
1022
|
+
*/
|
|
1023
|
+
lang?: string;
|
|
1024
|
+
}
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
*/
|
|
1028
|
+
interface CxTypographyAttributes extends HTMLAttributes<CxTypography> {
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
*
|
|
1032
|
+
*/
|
|
1033
|
+
variant?: 'body1' | 'body2' | 'body3' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'small';
|
|
1034
|
+
/**
|
|
1035
|
+
* Make localization attributes reactive
|
|
1036
|
+
*/
|
|
1037
|
+
dir?: string;
|
|
1038
|
+
/**
|
|
1039
|
+
*
|
|
1040
|
+
*/
|
|
1041
|
+
lang?: string;
|
|
1042
|
+
}
|
|
1043
|
+
/**
|
|
1044
|
+
* @summary Checkboxes allow the user to toggle an option on or off.
|
|
1045
|
+
*
|
|
1046
|
+
* @dependency cx-icon
|
|
1047
|
+
*
|
|
1048
|
+
* @slot - The checkbox's label.
|
|
1049
|
+
* @slot help-text - Text that describes how to use the checkbox. Alternatively, you can use the `help-text` attribute.
|
|
1050
|
+
*
|
|
1051
|
+
* @event cx-blur - Emitted when the checkbox loses focus.
|
|
1052
|
+
* @event cx-change - Emitted when the checked state changes.
|
|
1053
|
+
* @event cx-focus - Emitted when the checkbox gains focus.
|
|
1054
|
+
* @event cx-input - Emitted when the checkbox receives input.
|
|
1055
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
1056
|
+
*
|
|
1057
|
+
* @csspart base - The component's base wrapper.
|
|
1058
|
+
* @csspart control - The square container that wraps the checkbox's checked state.
|
|
1059
|
+
* @csspart control--checked - Matches the control part when the checkbox is checked.
|
|
1060
|
+
* @csspart control--indeterminate - Matches the control part when the checkbox is indeterminate.
|
|
1061
|
+
* @csspart checked-icon - The checked icon, an `cx-icon` element.
|
|
1062
|
+
* @csspart indeterminate-icon - The indeterminate icon, an `cx-icon` element.
|
|
1063
|
+
* @csspart label - The container that wraps the checkbox's label.
|
|
1064
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
1065
|
+
*/
|
|
1066
|
+
interface CxCheckboxAttributes extends HTMLAttributes<CxCheckbox> {
|
|
1067
|
+
|
|
1068
|
+
/**
|
|
1069
|
+
*
|
|
1070
|
+
*/
|
|
1071
|
+
title?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* make reactive to pass through The name of the checkbox, submitted as a name/value pair with form data.
|
|
1074
|
+
*/
|
|
1075
|
+
name?: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* The current value of the checkbox, submitted as a name/value pair with form data.
|
|
1078
|
+
*/
|
|
1079
|
+
value?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* The checkbox's size.
|
|
1082
|
+
*/
|
|
1083
|
+
size?: 'small' | 'medium' | 'large';
|
|
1084
|
+
/**
|
|
1085
|
+
* Disables the checkbox.
|
|
1086
|
+
*/
|
|
1087
|
+
disabled?: boolean;
|
|
1088
|
+
/**
|
|
1089
|
+
* Draws the checkbox in a checked state.
|
|
1090
|
+
*/
|
|
1091
|
+
checked?: boolean;
|
|
1092
|
+
/**
|
|
1093
|
+
* Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a "select
|
|
1094
|
+
* all/none" behavior when associated checkboxes have a mix of checked and unchecked states.
|
|
1095
|
+
*/
|
|
1096
|
+
indeterminate?: boolean;
|
|
1097
|
+
/**
|
|
1098
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
1099
|
+
*/
|
|
1100
|
+
defaultChecked?: boolean;
|
|
1101
|
+
/**
|
|
1102
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
1103
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
1104
|
+
* the same document or shadow root for this to work.
|
|
1105
|
+
*/
|
|
1106
|
+
form?: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* Makes the checkbox a required field.
|
|
1109
|
+
*/
|
|
1110
|
+
required?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* The checkbox's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
1113
|
+
*/
|
|
1114
|
+
helpText?: string;
|
|
1115
|
+
/**
|
|
1116
|
+
* Make localization attributes reactive
|
|
1117
|
+
*/
|
|
1118
|
+
dir?: string;
|
|
1119
|
+
/**
|
|
1120
|
+
*
|
|
1121
|
+
*/
|
|
1122
|
+
lang?: string;
|
|
1123
|
+
}
|
|
1124
|
+
/**
|
|
1125
|
+
* @summary Menu items provide options for the user to pick from in a menu.
|
|
1126
|
+
*
|
|
1127
|
+
* @dependency cx-icon
|
|
1128
|
+
* @dependency cx-popup
|
|
1129
|
+
* @dependency cx-spinner
|
|
1130
|
+
*
|
|
1131
|
+
* @slot - The menu item's label.
|
|
1132
|
+
* @slot prefix - Used to prepend an icon or similar element to the menu item.
|
|
1133
|
+
* @slot suffix - Used to append an icon or similar element to the menu item.
|
|
1134
|
+
* @slot submenu - Used to denote a nested menu.
|
|
1135
|
+
*
|
|
1136
|
+
* @csspart base - The component's base wrapper.
|
|
1137
|
+
* @csspart checked-icon - The checked icon, which is only visible when the menu item is checked.
|
|
1138
|
+
* @csspart prefix - The prefix container.
|
|
1139
|
+
* @csspart label - The menu item label.
|
|
1140
|
+
* @csspart suffix - The suffix container.
|
|
1141
|
+
* @csspart spinner - The spinner that shows when the menu item is in the loading state.
|
|
1142
|
+
* @csspart spinner__base - The spinner's base part.
|
|
1143
|
+
* @csspart submenu-icon - The submenu icon, visible only when the menu item has a submenu (not yet implemented).
|
|
1144
|
+
*
|
|
1145
|
+
* @cssproperty [--submenu-offset=-2px] - The distance submenus shift to overlap the parent menu.
|
|
1146
|
+
*/
|
|
1147
|
+
interface CxMenuItemAttributes extends HTMLAttributes<CxMenuItem> {
|
|
1148
|
+
|
|
1149
|
+
/**
|
|
1150
|
+
* The type of menu item to render. To use `checked`, this value must be set to `checkbox`.
|
|
1151
|
+
*/
|
|
1152
|
+
type?: 'normal' | 'checkbox';
|
|
1153
|
+
/**
|
|
1154
|
+
* Draws the item in a checked state.
|
|
1155
|
+
*/
|
|
1156
|
+
checked?: boolean;
|
|
1157
|
+
/**
|
|
1158
|
+
* A unique value to store in the menu item. This can be used as a way to identify menu items when selected.
|
|
1159
|
+
*/
|
|
1160
|
+
value?: string;
|
|
1161
|
+
/**
|
|
1162
|
+
* Draws the menu item in a loading state.
|
|
1163
|
+
*/
|
|
1164
|
+
loading?: boolean;
|
|
1165
|
+
/**
|
|
1166
|
+
* Draws the menu item in a disabled state, preventing selection.
|
|
1167
|
+
*/
|
|
1168
|
+
disabled?: boolean;
|
|
1169
|
+
/**
|
|
1170
|
+
* Makes the menu item readonly
|
|
1171
|
+
*/
|
|
1172
|
+
readonly?: boolean;
|
|
1173
|
+
/**
|
|
1174
|
+
* Make localization attributes reactive
|
|
1175
|
+
*/
|
|
1176
|
+
dir?: string;
|
|
1177
|
+
/**
|
|
1178
|
+
*
|
|
1179
|
+
*/
|
|
1180
|
+
lang?: string;
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* @summary Menus provide a list of options for the user to choose from.
|
|
1184
|
+
*
|
|
1185
|
+
* @slot - The menu's content, including menu items, menu labels, and dividers.
|
|
1186
|
+
*
|
|
1187
|
+
* @event {{ item: CxMenuItem }} cx-select - Emitted when a menu item is selected.
|
|
1188
|
+
*/
|
|
1189
|
+
interface CxMenuAttributes extends HTMLAttributes<CxMenu> {
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
*
|
|
1193
|
+
*/
|
|
1194
|
+
horizontal?: boolean;
|
|
1195
|
+
/**
|
|
1196
|
+
* Make localization attributes reactive
|
|
1197
|
+
*/
|
|
1198
|
+
dir?: string;
|
|
1199
|
+
/**
|
|
1200
|
+
*
|
|
1201
|
+
*/
|
|
1202
|
+
lang?: string;
|
|
1203
|
+
}
|
|
1204
|
+
/**
|
|
1205
|
+
* @summary Inputs collect data from the user.
|
|
1206
|
+
*
|
|
1207
|
+
* @dependency cx-icon
|
|
1208
|
+
*
|
|
1209
|
+
* @slot label - The input's label. Alternatively, you can use the `label` attribute.
|
|
1210
|
+
* @slot prefix - Used to prepend a presentational icon or similar element to the input.
|
|
1211
|
+
* @slot suffix - Used to append a presentational icon or similar element to the input.
|
|
1212
|
+
* @slot clear-icon - An icon to use in lieu of the default clear icon.
|
|
1213
|
+
* @slot show-password-icon - An icon to use in lieu of the default show password icon.
|
|
1214
|
+
* @slot hide-password-icon - An icon to use in lieu of the default hide password icon.
|
|
1215
|
+
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
1216
|
+
* @slot file-button - The button that opens the file picker. Alternatively, you can use the `file-button-label` attribute.
|
|
1217
|
+
*
|
|
1218
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
1219
|
+
* @event cx-change - Emitted when an alteration to the control's value is committed by the user.
|
|
1220
|
+
* @event cx-clear - Emitted when the clear button is activated.
|
|
1221
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
1222
|
+
* @event cx-input - Emitted when the control receives input.
|
|
1223
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
1224
|
+
* @event cx-keydown - Emitted when a key is pressed down on the control.
|
|
1225
|
+
*
|
|
1226
|
+
* @csspart form-control - The form control that wraps the label, input, and help text.
|
|
1227
|
+
* @csspart form-control-label - The label's wrapper.
|
|
1228
|
+
* @csspart form-control-input - The input's wrapper.
|
|
1229
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
1230
|
+
* @csspart base - The component's base wrapper.
|
|
1231
|
+
* @csspart input - The internal `input` control.
|
|
1232
|
+
* @csspart prefix - The container that wraps the prefix.
|
|
1233
|
+
* @csspart clear-button - The clear button.
|
|
1234
|
+
* @csspart password-toggle-button - The password toggle button.
|
|
1235
|
+
* @csspart suffix - The container that wraps the suffix.
|
|
1236
|
+
*/
|
|
1237
|
+
interface CxInputAttributes extends HTMLAttributes<CxInput> {
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
*/
|
|
1242
|
+
title?: string;
|
|
1243
|
+
/**
|
|
1244
|
+
* The type of input. Works the same as a native `input` element, but only a subset of types are supported. Defaults
|
|
1245
|
+
* to `text`.
|
|
1246
|
+
*/
|
|
1247
|
+
type?: 'number' | 'text' | 'search' | 'time' | 'date' | 'datetime-local' | 'email' | 'password' | 'tel' | 'file' | 'url';
|
|
1248
|
+
/**
|
|
1249
|
+
* The name of the input, submitted as a name/value pair with form data.
|
|
1250
|
+
*/
|
|
1251
|
+
name?: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* The current value of the input, submitted as a name/value pair with form data.
|
|
1254
|
+
*/
|
|
1255
|
+
value?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* If used with mask, this stores the input's value, with fixed strings omitted.
|
|
1258
|
+
*/
|
|
1259
|
+
unmaskedValue?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
1262
|
+
*/
|
|
1263
|
+
defaultValue?: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* The input's size.
|
|
1266
|
+
*/
|
|
1267
|
+
size?: 'small' | 'medium' | 'large';
|
|
1268
|
+
/**
|
|
1269
|
+
* Draws a filled input.
|
|
1270
|
+
*/
|
|
1271
|
+
filled?: boolean;
|
|
1272
|
+
/**
|
|
1273
|
+
* Draws a pill-style input with rounded edges.
|
|
1274
|
+
*/
|
|
1275
|
+
pill?: boolean;
|
|
1276
|
+
/**
|
|
1277
|
+
* The input's label. If you need to display HTML, use the `label` slot instead.
|
|
1278
|
+
*/
|
|
1279
|
+
label?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* The input's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
1282
|
+
*/
|
|
1283
|
+
helpText?: string;
|
|
1284
|
+
/**
|
|
1285
|
+
* Adds a clear button when the input is not empty.
|
|
1286
|
+
*/
|
|
1287
|
+
clearable?: boolean;
|
|
1288
|
+
/**
|
|
1289
|
+
* Disables the input.
|
|
1290
|
+
*/
|
|
1291
|
+
disabled?: boolean;
|
|
1292
|
+
/**
|
|
1293
|
+
* Placeholder text to show as a hint when the input is empty.
|
|
1294
|
+
*/
|
|
1295
|
+
placeholder?: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Makes the input readonly.
|
|
1298
|
+
*/
|
|
1299
|
+
readonly?: boolean;
|
|
1300
|
+
/**
|
|
1301
|
+
* Adds a button to toggle the password's visibility. Only applies to password types.
|
|
1302
|
+
*/
|
|
1303
|
+
passwordToggle?: boolean;
|
|
1304
|
+
/**
|
|
1305
|
+
* Determines whether or not the password is currently visible. Only applies to password input types.
|
|
1306
|
+
*/
|
|
1307
|
+
passwordVisible?: boolean;
|
|
1308
|
+
/**
|
|
1309
|
+
* Hides the browser's built-in increment/decrement spin buttons for number inputs.
|
|
1310
|
+
*/
|
|
1311
|
+
noSpinButtons?: boolean;
|
|
1312
|
+
/**
|
|
1313
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
1314
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
1315
|
+
* the same document or shadow root for this to work.
|
|
1316
|
+
*/
|
|
1317
|
+
form?: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Makes the input a required field.
|
|
1320
|
+
*/
|
|
1321
|
+
required?: boolean;
|
|
1322
|
+
/**
|
|
1323
|
+
* A regular expression pattern to validate input against.
|
|
1324
|
+
*/
|
|
1325
|
+
pattern?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* The minimum length of input that will be considered valid.
|
|
1328
|
+
*/
|
|
1329
|
+
minlength?: number;
|
|
1330
|
+
/**
|
|
1331
|
+
* The maximum length of input that will be considered valid.
|
|
1332
|
+
*/
|
|
1333
|
+
maxlength?: number;
|
|
1334
|
+
/**
|
|
1335
|
+
* The input's minimum value. Only applies to date and number input types.
|
|
1336
|
+
*/
|
|
1337
|
+
min?: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* The input's maximum value. Only applies to date and number input types.
|
|
1340
|
+
*/
|
|
1341
|
+
max?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is
|
|
1344
|
+
* implied, allowing any numeric value. Only applies to date and number input types.
|
|
1345
|
+
*/
|
|
1346
|
+
step?: string;
|
|
1347
|
+
/**
|
|
1348
|
+
* Controls whether and how text input is automatically capitalized as it is entered by the user.
|
|
1349
|
+
*/
|
|
1350
|
+
autocapitalize?: 'none' | 'on' | 'off' | 'sentences' | 'words' | 'characters';
|
|
1351
|
+
/**
|
|
1352
|
+
* Indicates whether the browser's autocorrect feature is on or off.
|
|
1353
|
+
*/
|
|
1354
|
+
autocorrect?: 'on' | 'off';
|
|
1355
|
+
/**
|
|
1356
|
+
* Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
|
|
1357
|
+
* [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
|
|
1358
|
+
*/
|
|
1359
|
+
autocomplete?: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* Indicates that the input should receive focus on page load.
|
|
1362
|
+
*/
|
|
1363
|
+
autofocus?: boolean;
|
|
1364
|
+
/**
|
|
1365
|
+
* Used to customize the label or icon of the Enter key on virtual keyboards.
|
|
1366
|
+
*/
|
|
1367
|
+
enterkeyhint?: 'search' | 'enter' | 'done' | 'go' | 'next' | 'previous' | 'send';
|
|
1368
|
+
/**
|
|
1369
|
+
* Enables spell checking on the input.
|
|
1370
|
+
*/
|
|
1371
|
+
spellcheck?: boolean;
|
|
1372
|
+
/**
|
|
1373
|
+
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
|
|
1374
|
+
* keyboard on supportive devices.
|
|
1375
|
+
*/
|
|
1376
|
+
inputmode?: 'none' | 'text' | 'search' | 'email' | 'tel' | 'url' | 'decimal' | 'numeric';
|
|
1377
|
+
/**
|
|
1378
|
+
* #region Input Mask properties The mask pattern to apply to the input.
|
|
1379
|
+
*/
|
|
1380
|
+
mask?: string;
|
|
1381
|
+
/**
|
|
1382
|
+
* The character to use as a placeholder when the input is empty. Defaults to '_'.
|
|
1383
|
+
*/
|
|
1384
|
+
maskPlaceholder?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* Whether or not to lazy mask the input. When `true`, the mask will only be applied after the user starts typing.
|
|
1387
|
+
*/
|
|
1388
|
+
maskLazy?: boolean;
|
|
1389
|
+
/**
|
|
1390
|
+
* Enables characters overwriting instead of inserting.
|
|
1391
|
+
*/
|
|
1392
|
+
maskOverwrite?: string;
|
|
1393
|
+
/**
|
|
1394
|
+
* The `accept` attribute of the file input. This attribute contains a comma-separated list of unique file type
|
|
1395
|
+
* For example, `accept="image/png, image/jpeg"`.
|
|
1396
|
+
*/
|
|
1397
|
+
accept?: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* The `multiple` attribute of the file input. This attribute indicates that the user can enter more than one value.
|
|
1400
|
+
*/
|
|
1401
|
+
multiple?: boolean;
|
|
1402
|
+
/**
|
|
1403
|
+
* The Choose file's theme variant.
|
|
1404
|
+
*/
|
|
1405
|
+
variant?: 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'default' | 'text' | 'tertiary';
|
|
1406
|
+
/**
|
|
1407
|
+
*
|
|
1408
|
+
*/
|
|
1409
|
+
fileButtonLabel?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
*/
|
|
1413
|
+
buttonOnly?: boolean;
|
|
1414
|
+
/**
|
|
1415
|
+
* Make localization attributes reactive
|
|
1416
|
+
*/
|
|
1417
|
+
dir?: string;
|
|
1418
|
+
/**
|
|
1419
|
+
*
|
|
1420
|
+
*/
|
|
1421
|
+
lang?: string;
|
|
1422
|
+
}
|
|
1423
|
+
/**
|
|
1424
|
+
* @summary Dropdowns expose additional content that "drops down" in a panel.
|
|
1425
|
+
*
|
|
1426
|
+
* @dependency cx-popup
|
|
1427
|
+
*
|
|
1428
|
+
* @slot - The dropdown's main content.
|
|
1429
|
+
* @slot trigger - The dropdown's trigger, usually a `cx-button` element.
|
|
1430
|
+
*
|
|
1431
|
+
* @event cx-show - Emitted when the dropdown opens.
|
|
1432
|
+
* @event cx-after-show - Emitted after the dropdown opens and all animations are complete.
|
|
1433
|
+
* @event cx-hide - Emitted when the dropdown closes.
|
|
1434
|
+
* @event cx-after-hide - Emitted after the dropdown closes and all animations are complete.
|
|
1435
|
+
*
|
|
1436
|
+
* @csspart base - The component's base wrapper.
|
|
1437
|
+
* @csspart trigger - The container that wraps the trigger.
|
|
1438
|
+
* @csspart panel - The panel that gets shown when the dropdown is open.
|
|
1439
|
+
*
|
|
1440
|
+
* @animation dropdown.show - The animation to use when showing the dropdown.
|
|
1441
|
+
* @animation dropdown.hide - The animation to use when hiding the dropdown.
|
|
1442
|
+
*/
|
|
1443
|
+
interface CxDropdownAttributes extends HTMLAttributes<CxDropdown> {
|
|
1444
|
+
|
|
1445
|
+
/**
|
|
1446
|
+
* Indicates whether or not the dropdown is open. You can toggle this attribute to show and hide the dropdown, or you
|
|
1447
|
+
* can use the `show()` and `hide()` methods and this attribute will reflect the dropdown's open state.
|
|
1448
|
+
*/
|
|
1449
|
+
open?: boolean;
|
|
1450
|
+
/**
|
|
1451
|
+
* The preferred placement of the dropdown panel. Note that the actual placement may vary as needed to keep the panel
|
|
1452
|
+
* inside of the viewport.
|
|
1453
|
+
*/
|
|
1454
|
+
placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';
|
|
1455
|
+
/**
|
|
1456
|
+
* Disables the dropdown so the panel will not open.
|
|
1457
|
+
*/
|
|
1458
|
+
disabled?: boolean;
|
|
1459
|
+
/**
|
|
1460
|
+
* By default, the dropdown is closed when an item is selected. This attribute will keep it open instead. Useful for
|
|
1461
|
+
* dropdowns that allow for multiple interactions.
|
|
1462
|
+
*/
|
|
1463
|
+
stayOpenOnSelect?: boolean;
|
|
1464
|
+
/**
|
|
1465
|
+
* The distance in pixels from which to offset the panel away from its trigger.
|
|
1466
|
+
*/
|
|
1467
|
+
distance?: number;
|
|
1468
|
+
/**
|
|
1469
|
+
* The distance in pixels from which to offset the panel along its trigger.
|
|
1470
|
+
*/
|
|
1471
|
+
skidding?: number;
|
|
1472
|
+
/**
|
|
1473
|
+
* Enable this option to prevent the panel from being clipped when the component is placed inside a container with
|
|
1474
|
+
* `overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
|
|
1475
|
+
*/
|
|
1476
|
+
hoist?: boolean;
|
|
1477
|
+
/**
|
|
1478
|
+
* Syncs the popup width or height to that of the trigger element.
|
|
1479
|
+
*/
|
|
1480
|
+
sync?: 'both' | 'width' | 'height';
|
|
1481
|
+
/**
|
|
1482
|
+
* The factor by which to multiply the available width when using `auto-size`. E.g: Set to 0.5 to
|
|
1483
|
+
* make the popup half the width of the available space.
|
|
1484
|
+
*/
|
|
1485
|
+
autoWidthFactor?: number;
|
|
1486
|
+
/**
|
|
1487
|
+
* Make localization attributes reactive
|
|
1488
|
+
*/
|
|
1489
|
+
dir?: string;
|
|
1490
|
+
/**
|
|
1491
|
+
*
|
|
1492
|
+
*/
|
|
1493
|
+
lang?: string;
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* @summary Dividers are used to visually separate or group elements.
|
|
1497
|
+
*
|
|
1498
|
+
* @cssproperty --color - The color of the divider.
|
|
1499
|
+
* @cssproperty --width - The width of the divider.
|
|
1500
|
+
* @cssproperty --spacing - The spacing of the divider.
|
|
1501
|
+
*/
|
|
1502
|
+
interface CxDividerAttributes extends HTMLAttributes<CxDivider> {
|
|
1503
|
+
|
|
1504
|
+
/**
|
|
1505
|
+
* Draws the divider in a vertical orientation.
|
|
1506
|
+
*/
|
|
1507
|
+
vertical?: boolean;
|
|
1508
|
+
/**
|
|
1509
|
+
* Make localization attributes reactive
|
|
1510
|
+
*/
|
|
1511
|
+
dir?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
*
|
|
1514
|
+
*/
|
|
1515
|
+
lang?: string;
|
|
1516
|
+
}
|
|
1517
|
+
/**
|
|
1518
|
+
* @summary The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.
|
|
1519
|
+
*
|
|
1520
|
+
* @slot - The content to be visually hidden.
|
|
1521
|
+
*/
|
|
1522
|
+
interface CxVisuallyHiddenAttributes extends HTMLAttributes<CxVisuallyHidden> {
|
|
1523
|
+
|
|
1524
|
+
/**
|
|
1525
|
+
* Make localization attributes reactive
|
|
1526
|
+
*/
|
|
1527
|
+
dir?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
*
|
|
1530
|
+
*/
|
|
1531
|
+
lang?: string;
|
|
1532
|
+
}
|
|
1533
|
+
/**
|
|
1534
|
+
* @summary Color pickers allow the user to select a color.
|
|
1535
|
+
*
|
|
1536
|
+
* @dependency cx-button
|
|
1537
|
+
* @dependency cx-button-group
|
|
1538
|
+
* @dependency cx-dropdown
|
|
1539
|
+
* @dependency cx-input
|
|
1540
|
+
* @dependency cx-visually-hidden
|
|
1541
|
+
*
|
|
1542
|
+
* @slot label - The color picker's form label. Alternatively, you can use the `label` attribute.
|
|
1543
|
+
*
|
|
1544
|
+
* @event cx-blur - Emitted when the color picker loses focus.
|
|
1545
|
+
* @event cx-change - Emitted when the color picker's value changes.
|
|
1546
|
+
* @event cx-focus - Emitted when the color picker receives focus.
|
|
1547
|
+
* @event cx-input - Emitted when the color picker receives input.
|
|
1548
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
1549
|
+
* @event cx-swatch-add - Emitted when a color is added to the custom swatches.
|
|
1550
|
+
*
|
|
1551
|
+
* @csspart base - The component's base wrapper.
|
|
1552
|
+
* @csspart trigger - The color picker's dropdown trigger.
|
|
1553
|
+
* @csspart swatches - The container that holds the swatches.
|
|
1554
|
+
* @csspart swatch - Each individual swatch.
|
|
1555
|
+
* @csspart grid - The color grid.
|
|
1556
|
+
* @csspart grid-handle - The color grid's handle.
|
|
1557
|
+
* @csspart slider - Hue and opacity sliders.
|
|
1558
|
+
* @csspart slider-handle - Hue and opacity slider handles.
|
|
1559
|
+
* @csspart hue-slider - The hue slider.
|
|
1560
|
+
* @csspart hue-slider-handle - The hue slider's handle.
|
|
1561
|
+
* @csspart opacity-slider - The opacity slider.
|
|
1562
|
+
* @csspart opacity-slider-handle - The opacity slider's handle.
|
|
1563
|
+
* @csspart preview - The preview color.
|
|
1564
|
+
* @csspart input - The text input.
|
|
1565
|
+
* @csspart eye-dropper-button - The eye dropper button.
|
|
1566
|
+
* @csspart eye-dropper-button__base - The eye dropper button's exported `button` part.
|
|
1567
|
+
* @csspart eye-dropper-button__prefix - The eye dropper button's exported `prefix` part.
|
|
1568
|
+
* @csspart eye-dropper-button__label - The eye dropper button's exported `label` part.
|
|
1569
|
+
* @csspart eye-dropper-button__suffix - The eye dropper button's exported `suffix` part.
|
|
1570
|
+
* @csspart eye-dropper-button__caret - The eye dropper button's exported `caret` part.
|
|
1571
|
+
* @csspart format-button - The format button.
|
|
1572
|
+
* @csspart format-button__base - The format button's exported `button` part.
|
|
1573
|
+
* @csspart format-button__prefix - The format button's exported `prefix` part.
|
|
1574
|
+
* @csspart format-button__label - The format button's exported `label` part.
|
|
1575
|
+
* @csspart format-button__suffix - The format button's exported `suffix` part.
|
|
1576
|
+
* @csspart format-button__caret - The format button's exported `caret` part.
|
|
1577
|
+
*
|
|
1578
|
+
* @cssproperty --grid-width - The width of the color grid.
|
|
1579
|
+
* @cssproperty --grid-height - The height of the color grid.
|
|
1580
|
+
* @cssproperty --grid-handle-size - The size of the color grid's handle.
|
|
1581
|
+
* @cssproperty --slider-height - The height of the hue and alpha sliders.
|
|
1582
|
+
* @cssproperty --slider-handle-size - The diameter of the slider's handle.
|
|
1583
|
+
* @cssproperty --swatch-size - The size of each predefined color swatch.
|
|
1584
|
+
*/
|
|
1585
|
+
interface CxColorPickerAttributes extends HTMLAttributes<CxColorPicker> {
|
|
1586
|
+
|
|
1587
|
+
/**
|
|
1588
|
+
* The current value of the color picker. The value's format will vary based the `format` attribute. To get the value
|
|
1589
|
+
* in a specific format, use the `getFormattedValue()` method. The value is submitted as a name/value pair with form
|
|
1590
|
+
* data.
|
|
1591
|
+
*/
|
|
1592
|
+
value?: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
1595
|
+
*/
|
|
1596
|
+
defaultValue?: string;
|
|
1597
|
+
/**
|
|
1598
|
+
* The color picker's label. This will not be displayed, but it will be announced by assistive devices. If you need to
|
|
1599
|
+
* display HTML, you can use the `label` slot` instead.
|
|
1600
|
+
*/
|
|
1601
|
+
label?: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* The variant of the form control.
|
|
1604
|
+
*/
|
|
1605
|
+
variant?: 'button' | 'default';
|
|
1606
|
+
/**
|
|
1607
|
+
* The format to use. If opacity is enabled, these will translate to HEXA, RGBA, HSLA, and HSVA respectively. The color
|
|
1608
|
+
* picker will accept user input in any format (including CSS color names) and convert it to the desired format.
|
|
1609
|
+
*/
|
|
1610
|
+
format?: 'hex' | 'rgb' | 'hsl' | 'hsv';
|
|
1611
|
+
/**
|
|
1612
|
+
* Renders the color picker inline rather than in a dropdown.
|
|
1613
|
+
*/
|
|
1614
|
+
inline?: boolean;
|
|
1615
|
+
/**
|
|
1616
|
+
* Determines the size of the color picker's trigger. This has no effect on inline color pickers.
|
|
1617
|
+
*/
|
|
1618
|
+
size?: 'small' | 'medium' | 'large';
|
|
1619
|
+
/**
|
|
1620
|
+
* Removes the button that lets users toggle between format.
|
|
1621
|
+
*/
|
|
1622
|
+
noFormatToggle?: boolean;
|
|
1623
|
+
/**
|
|
1624
|
+
* The name of the form control, submitted as a name/value pair with form data.
|
|
1625
|
+
*/
|
|
1626
|
+
name?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* Disables the color picker.
|
|
1629
|
+
*/
|
|
1630
|
+
disabled?: boolean;
|
|
1631
|
+
/**
|
|
1632
|
+
* Enable this option to prevent the panel from being clipped when the component is placed inside a container with
|
|
1633
|
+
* `overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
|
|
1634
|
+
*/
|
|
1635
|
+
hoist?: boolean;
|
|
1636
|
+
/**
|
|
1637
|
+
* Shows the opacity slider. Enabling this will cause the formatted value to be HEXA, RGBA, or HSLA.
|
|
1638
|
+
*/
|
|
1639
|
+
opacity?: boolean;
|
|
1640
|
+
/**
|
|
1641
|
+
* By default, values are lowercase. With this attribute, values will be uppercase instead.
|
|
1642
|
+
*/
|
|
1643
|
+
uppercase?: boolean;
|
|
1644
|
+
/**
|
|
1645
|
+
* Adds a clear button when the input is not empty.
|
|
1646
|
+
*/
|
|
1647
|
+
clearable?: boolean;
|
|
1648
|
+
/**
|
|
1649
|
+
* One or more predefined color swatches to display as presets in the color picker. Can include any format the color
|
|
1650
|
+
* picker can parse, including HEX(A), RGB(A), HSL(A), HSV(A), and CSS color names. Each color must be separated by a
|
|
1651
|
+
* semicolon (`;`). Alternatively, you can pass an array of color values to this property using JavaScript.
|
|
1652
|
+
*/
|
|
1653
|
+
swatches?: string;
|
|
1654
|
+
/**
|
|
1655
|
+
* Similar to swatches, but for user-defined custom colors.
|
|
1656
|
+
*/
|
|
1657
|
+
customSwatches?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* Set to true to display a loading spinner.
|
|
1660
|
+
*/
|
|
1661
|
+
loading?: boolean;
|
|
1662
|
+
/**
|
|
1663
|
+
* Set to true to display a button that allows user to add current color to custom swatches.
|
|
1664
|
+
*/
|
|
1665
|
+
creatable?: boolean;
|
|
1666
|
+
/**
|
|
1667
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
1668
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
1669
|
+
* the same document or shadow root for this to work.
|
|
1670
|
+
*/
|
|
1671
|
+
form?: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* Makes the color picker a required field.
|
|
1674
|
+
*/
|
|
1675
|
+
required?: boolean;
|
|
1676
|
+
/**
|
|
1677
|
+
* Make localization attributes reactive
|
|
1678
|
+
*/
|
|
1679
|
+
dir?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
*
|
|
1682
|
+
*/
|
|
1683
|
+
lang?: string;
|
|
1684
|
+
}
|
|
1685
|
+
/**
|
|
1686
|
+
* @summary Copies text data to the clipboard when the user clicks the trigger.
|
|
1687
|
+
*
|
|
1688
|
+
* @dependency cx-icon
|
|
1689
|
+
* @dependency cx-tooltip
|
|
1690
|
+
*
|
|
1691
|
+
* @event cx-copy - Emitted when the data has been copied.
|
|
1692
|
+
* @event cx-error - Emitted when the data could not be copied.
|
|
1693
|
+
*
|
|
1694
|
+
* @slot copy-icon - The icon to show in the default copy state. Works best with `cx-icon`.
|
|
1695
|
+
* @slot success-icon - The icon to show when the content is copied. Works best with `cx-icon`.
|
|
1696
|
+
* @slot error-icon - The icon to show when a copy error occurs. Works best with `cx-icon`.
|
|
1697
|
+
*
|
|
1698
|
+
* @csspart button - The internal `button` element.
|
|
1699
|
+
* @csspart copy-icon - The container that holds the copy icon.
|
|
1700
|
+
* @csspart success-icon - The container that holds the success icon.
|
|
1701
|
+
* @csspart error-icon - The container that holds the error icon.
|
|
1702
|
+
* @csspart tooltip__base - The tooltip's exported `base` part.
|
|
1703
|
+
* @csspart tooltip__base__popup - The tooltip's exported `popup` part.
|
|
1704
|
+
* @csspart tooltip__base__arrow - The tooltip's exported `arrow` part.
|
|
1705
|
+
* @csspart tooltip__body - The tooltip's exported `body` part.
|
|
1706
|
+
*
|
|
1707
|
+
* @cssproperty --success-color - The color to use for success feedback.
|
|
1708
|
+
* @cssproperty --error-color - The color to use for error feedback.
|
|
1709
|
+
*
|
|
1710
|
+
* @animation copy.in - The animation to use when feedback icons animate in.
|
|
1711
|
+
* @animation copy.out - The animation to use when feedback icons animate out.
|
|
1712
|
+
*/
|
|
1713
|
+
interface CxCopyButtonAttributes extends HTMLAttributes<CxCopyButton> {
|
|
1714
|
+
|
|
1715
|
+
/**
|
|
1716
|
+
* The text value to copy.
|
|
1717
|
+
*/
|
|
1718
|
+
value?: string;
|
|
1719
|
+
/**
|
|
1720
|
+
* An id that references an element in the same document from which data will be copied. If both this and `value` are
|
|
1721
|
+
* present, this value will take precedence. By default, the target element's `textContent` will be copied. To copy an
|
|
1722
|
+
* attribute, append the attribute name wrapped in square brackets, e.g. `from="el[value]"`. To copy a property,
|
|
1723
|
+
* append a dot and the property name, e.g. `from="el.value"`.
|
|
1724
|
+
*/
|
|
1725
|
+
from?: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* Disables the copy button.
|
|
1728
|
+
*/
|
|
1729
|
+
disabled?: boolean;
|
|
1730
|
+
/**
|
|
1731
|
+
* A custom label to show in the tooltip.
|
|
1732
|
+
*/
|
|
1733
|
+
copyLabel?: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* A custom label to show in the tooltip after copying.
|
|
1736
|
+
*/
|
|
1737
|
+
successLabel?: string;
|
|
1738
|
+
/**
|
|
1739
|
+
* A custom label to show in the tooltip when a copy error occurs.
|
|
1740
|
+
*/
|
|
1741
|
+
errorLabel?: string;
|
|
1742
|
+
/**
|
|
1743
|
+
* The length of time to show feedback before restoring the default trigger.
|
|
1744
|
+
*/
|
|
1745
|
+
feedbackDuration?: number;
|
|
1746
|
+
/**
|
|
1747
|
+
* The preferred placement of the tooltip.
|
|
1748
|
+
*/
|
|
1749
|
+
tooltipPlacement?: 'top' | 'bottom' | 'right' | 'left';
|
|
1750
|
+
/**
|
|
1751
|
+
* Enable this option to prevent the tooltip from being clipped when the component is placed inside a container with
|
|
1752
|
+
* `overflow: auto|hidden|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all,
|
|
1753
|
+
* scenarios.
|
|
1754
|
+
*/
|
|
1755
|
+
hoist?: boolean;
|
|
1756
|
+
/**
|
|
1757
|
+
* Make localization attributes reactive
|
|
1758
|
+
*/
|
|
1759
|
+
dir?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
*
|
|
1762
|
+
*/
|
|
1763
|
+
lang?: string;
|
|
1764
|
+
}
|
|
1765
|
+
/**
|
|
1766
|
+
* @summary Details show a brief summary and expand to show additional content.
|
|
1767
|
+
*
|
|
1768
|
+
* @dependency cx-icon
|
|
1769
|
+
*
|
|
1770
|
+
* @slot - The details' main content.
|
|
1771
|
+
* @slot summary - The details' summary. Alternatively, you can use the `summary` attribute.
|
|
1772
|
+
* @slot expand-icon - Optional expand icon to use instead of the default. Works best with `cx-icon`.
|
|
1773
|
+
* @slot collapse-icon - Optional collapse icon to use instead of the default. Works best with `cx-icon`.
|
|
1774
|
+
*
|
|
1775
|
+
* @event cx-show - Emitted when the details opens.
|
|
1776
|
+
* @event cx-after-show - Emitted after the details opens and all animations are complete.
|
|
1777
|
+
* @event cx-hide - Emitted when the details closes.
|
|
1778
|
+
* @event cx-after-hide - Emitted after the details closes and all animations are complete.
|
|
1779
|
+
*
|
|
1780
|
+
* @csspart base - The component's base wrapper.
|
|
1781
|
+
* @csspart header - The header that wraps both the summary and the expand/collapse icon.
|
|
1782
|
+
* @csspart summary - The container that wraps the summary.
|
|
1783
|
+
* @csspart summary-icon - The container that wraps the expand/collapse icons.
|
|
1784
|
+
* @csspart content - The details content.
|
|
1785
|
+
*
|
|
1786
|
+
* @animation details.show - The animation to use when showing details. You can use `height: auto` with this animation.
|
|
1787
|
+
* @animation details.hide - The animation to use when hiding details. You can use `height: auto` with this animation.
|
|
1788
|
+
*/
|
|
1789
|
+
interface CxDetailsAttributes extends HTMLAttributes<CxDetails> {
|
|
1790
|
+
|
|
1791
|
+
/**
|
|
1792
|
+
* Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you
|
|
1793
|
+
* can use the `show()` and `hide()` methods and this attribute will reflect the details' open state.
|
|
1794
|
+
*/
|
|
1795
|
+
open?: boolean;
|
|
1796
|
+
/**
|
|
1797
|
+
* The summary to show in the header. If you need to display HTML, use the `summary` slot instead.
|
|
1798
|
+
*/
|
|
1799
|
+
summary?: string;
|
|
1800
|
+
/**
|
|
1801
|
+
* Disables the details so it can't be toggled.
|
|
1802
|
+
*/
|
|
1803
|
+
disabled?: boolean;
|
|
1804
|
+
/**
|
|
1805
|
+
* Make localization attributes reactive
|
|
1806
|
+
*/
|
|
1807
|
+
dir?: string;
|
|
1808
|
+
/**
|
|
1809
|
+
*
|
|
1810
|
+
*/
|
|
1811
|
+
lang?: string;
|
|
1812
|
+
}
|
|
1813
|
+
/**
|
|
1814
|
+
* @summary Dialogs, sometimes called "modals", appear above the page and require the user's immediate attention.
|
|
1815
|
+
*
|
|
1816
|
+
* @dependency cx-icon-button
|
|
1817
|
+
* @dependency cx-divider
|
|
1818
|
+
*
|
|
1819
|
+
* @slot - The dialog's main content.
|
|
1820
|
+
* @slot label - The dialog's label. Alternatively, you can use the `label` attribute.
|
|
1821
|
+
* @slot header-actions - Optional actions to add to the header. Works best with `cx-icon-button`.
|
|
1822
|
+
* @slot footer - The dialog's footer, usually one or more buttons representing various options.
|
|
1823
|
+
*
|
|
1824
|
+
* @event cx-show - Emitted when the dialog opens.
|
|
1825
|
+
* @event cx-after-show - Emitted after the dialog opens and all animations are complete.
|
|
1826
|
+
* @event cx-hide - Emitted when the dialog closes.
|
|
1827
|
+
* @event cx-after-hide - Emitted after the dialog closes and all animations are complete.
|
|
1828
|
+
* @event cx-initial-focus - Emitted when the dialog opens and is ready to receive focus. Calling
|
|
1829
|
+
* `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
|
|
1830
|
+
* @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} cx-request-close - Emitted when the user attempts to
|
|
1831
|
+
* close the dialog by clicking the close button, clicking the overlay, or pressing escape. Calling
|
|
1832
|
+
* `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog will result in
|
|
1833
|
+
* destructive behavior such as data loss.
|
|
1834
|
+
*
|
|
1835
|
+
* @csspart base - The component's base wrapper.
|
|
1836
|
+
* @csspart overlay - The overlay that covers the screen behind the dialog.
|
|
1837
|
+
* @csspart panel - The dialog's panel (where the dialog and its content are rendered).
|
|
1838
|
+
* @csspart header - The dialog's header. This element wraps the title and header actions.
|
|
1839
|
+
* @csspart header-actions - Optional actions to add to the header. Works best with `cx-icon-button`.
|
|
1840
|
+
* @csspart title - The dialog's title.
|
|
1841
|
+
* @csspart close-button - The close button, an `cx-icon-button`.
|
|
1842
|
+
* @csspart close-button__base - The close button's exported `base` part.
|
|
1843
|
+
* @csspart body - The dialog's body.
|
|
1844
|
+
* @csspart footer - The dialog's footer.
|
|
1845
|
+
*
|
|
1846
|
+
* @cssproperty --width - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens.
|
|
1847
|
+
* @cssproperty --header-spacing - The amount of padding to use for the header.
|
|
1848
|
+
* @cssproperty --body-spacing - The amount of padding to use for the body.
|
|
1849
|
+
* @cssproperty --footer-spacing - The amount of padding to use for the footer.
|
|
1850
|
+
*
|
|
1851
|
+
* @animation dialog.show - The animation to use when showing the dialog.
|
|
1852
|
+
* @animation dialog.hide - The animation to use when hiding the dialog.
|
|
1853
|
+
* @animation dialog.denyClose - The animation to use when a request to close the dialog is denied.
|
|
1854
|
+
* @animation dialog.overlay.show - The animation to use when showing the dialog's overlay.
|
|
1855
|
+
* @animation dialog.overlay.hide - The animation to use when hiding the dialog's overlay.
|
|
1856
|
+
*
|
|
1857
|
+
* @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus
|
|
1858
|
+
* trapping and allow third-party modals spawned from an active Shoelace modal, call `modal.activateExternal()` when
|
|
1859
|
+
* the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Shoelace's focus trapping.
|
|
1860
|
+
*/
|
|
1861
|
+
interface CxDialogAttributes extends HTMLAttributes<CxDialog> {
|
|
1862
|
+
|
|
1863
|
+
/**
|
|
1864
|
+
* Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can
|
|
1865
|
+
* use the `show()` and `hide()` methods and this attribute will reflect the dialog's open state.
|
|
1866
|
+
*/
|
|
1867
|
+
open?: boolean;
|
|
1868
|
+
/**
|
|
1869
|
+
* The dialog's label as displayed in the header. You should always include a relevant label even when using
|
|
1870
|
+
* `no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead.
|
|
1871
|
+
*/
|
|
1872
|
+
label?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* Disables the header. This will also remove the default close button, so please ensure you provide an easy,
|
|
1875
|
+
* accessible way for users to dismiss the dialog.
|
|
1876
|
+
*/
|
|
1877
|
+
noHeader?: boolean;
|
|
1878
|
+
/**
|
|
1879
|
+
* Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is
|
|
1880
|
+
* clipped, using a `fixed` position strategy can often workaround it.
|
|
1881
|
+
*/
|
|
1882
|
+
strategy?: 'absolute' | 'fixed';
|
|
1883
|
+
/**
|
|
1884
|
+
* Make localization attributes reactive
|
|
1885
|
+
*/
|
|
1886
|
+
dir?: string;
|
|
1887
|
+
/**
|
|
1888
|
+
*
|
|
1889
|
+
*/
|
|
1890
|
+
lang?: string;
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* @summary Drawers slide in from a container to expose additional options and information.
|
|
1894
|
+
*
|
|
1895
|
+
* @dependency cx-icon-button
|
|
1896
|
+
*
|
|
1897
|
+
* @slot - The drawer's main content.
|
|
1898
|
+
* @slot label - The drawer's label. Alternatively, you can use the `label` attribute.
|
|
1899
|
+
* @slot header-actions - Optional actions to add to the header. Works best with `cx-icon-button`.
|
|
1900
|
+
* @slot footer - The drawer's footer, usually one or more buttons representing various options.
|
|
1901
|
+
*
|
|
1902
|
+
* @event cx-show - Emitted when the drawer opens.
|
|
1903
|
+
* @event cx-after-show - Emitted after the drawer opens and all animations are complete.
|
|
1904
|
+
* @event cx-hide - Emitted when the drawer closes.
|
|
1905
|
+
* @event cx-after-hide - Emitted after the drawer closes and all animations are complete.
|
|
1906
|
+
* @event cx-initial-focus - Emitted when the drawer opens and is ready to receive focus. Calling
|
|
1907
|
+
* `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
|
|
1908
|
+
* @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} cx-request-close - Emitted when the user attempts to
|
|
1909
|
+
* close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling
|
|
1910
|
+
* `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in
|
|
1911
|
+
* destructive behavior such as data loss.
|
|
1912
|
+
*
|
|
1913
|
+
* @csspart base - The component's base wrapper.
|
|
1914
|
+
* @csspart overlay - The overlay that covers the screen behind the drawer.
|
|
1915
|
+
* @csspart panel - The drawer's panel (where the drawer and its content are rendered).
|
|
1916
|
+
* @csspart header - The drawer's header. This element wraps the title and header actions.
|
|
1917
|
+
* @csspart header-actions - Optional actions to add to the header. Works best with `cx-icon-button`.
|
|
1918
|
+
* @csspart title - The drawer's title.
|
|
1919
|
+
* @csspart close-button - The close button, an `cx-icon-button`.
|
|
1920
|
+
* @csspart close-button__base - The close button's exported `base` part.
|
|
1921
|
+
* @csspart body - The drawer's body.
|
|
1922
|
+
* @csspart footer - The drawer's footer.
|
|
1923
|
+
*
|
|
1924
|
+
* @cssproperty --size - The preferred size of the drawer. This will be applied to the drawer's width or height
|
|
1925
|
+
* depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens.
|
|
1926
|
+
* @cssproperty --header-spacing - The amount of padding to use for the header.
|
|
1927
|
+
* @cssproperty --body-spacing - The amount of padding to use for the body.
|
|
1928
|
+
* @cssproperty --footer-spacing - The amount of padding to use for the footer.
|
|
1929
|
+
*
|
|
1930
|
+
* @animation drawer.showTop - The animation to use when showing a drawer with `top` placement.
|
|
1931
|
+
* @animation drawer.showEnd - The animation to use when showing a drawer with `end` placement.
|
|
1932
|
+
* @animation drawer.showBottom - The animation to use when showing a drawer with `bottom` placement.
|
|
1933
|
+
* @animation drawer.showStart - The animation to use when showing a drawer with `start` placement.
|
|
1934
|
+
* @animation drawer.hideTop - The animation to use when hiding a drawer with `top` placement.
|
|
1935
|
+
* @animation drawer.hideEnd - The animation to use when hiding a drawer with `end` placement.
|
|
1936
|
+
* @animation drawer.hideBottom - The animation to use when hiding a drawer with `bottom` placement.
|
|
1937
|
+
* @animation drawer.hideStart - The animation to use when hiding a drawer with `start` placement.
|
|
1938
|
+
* @animation drawer.denyClose - The animation to use when a request to close the drawer is denied.
|
|
1939
|
+
* @animation drawer.overlay.show - The animation to use when showing the drawer's overlay.
|
|
1940
|
+
* @animation drawer.overlay.hide - The animation to use when hiding the drawer's overlay.
|
|
1941
|
+
*
|
|
1942
|
+
* @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus
|
|
1943
|
+
* trapping and allow third-party modals spawned from an active Shoelace modal, call `modal.activateExternal()` when
|
|
1944
|
+
* the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Shoelace's focus trapping.
|
|
1945
|
+
*/
|
|
1946
|
+
interface CxDrawerAttributes extends HTMLAttributes<CxDrawer> {
|
|
1947
|
+
|
|
1948
|
+
/**
|
|
1949
|
+
* Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can
|
|
1950
|
+
* use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.
|
|
1951
|
+
*/
|
|
1952
|
+
open?: boolean;
|
|
1953
|
+
/**
|
|
1954
|
+
* The drawer's label as displayed in the header. You should always include a relevant label even when using
|
|
1955
|
+
* `no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead.
|
|
1956
|
+
*/
|
|
1957
|
+
label?: string;
|
|
1958
|
+
/**
|
|
1959
|
+
* The direction from which the drawer will open.
|
|
1960
|
+
*/
|
|
1961
|
+
placement?: 'top' | 'bottom' | 'start' | 'end';
|
|
1962
|
+
/**
|
|
1963
|
+
* By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of
|
|
1964
|
+
* its parent element, set this attribute and add `position: relative` to the parent.
|
|
1965
|
+
*/
|
|
1966
|
+
contained?: boolean;
|
|
1967
|
+
/**
|
|
1968
|
+
* Removes the header. This will also remove the default close button, so please ensure you provide an easy,
|
|
1969
|
+
* accessible way for users to dismiss the drawer.
|
|
1970
|
+
*/
|
|
1971
|
+
noHeader?: boolean;
|
|
1972
|
+
/**
|
|
1973
|
+
* Make localization attributes reactive
|
|
1974
|
+
*/
|
|
1975
|
+
dir?: string;
|
|
1976
|
+
/**
|
|
1977
|
+
*
|
|
1978
|
+
*/
|
|
1979
|
+
lang?: string;
|
|
1980
|
+
}
|
|
1981
|
+
/**
|
|
1982
|
+
* @summary Details show a brief summary and expand to show additional content.
|
|
1983
|
+
*
|
|
1984
|
+
* @dependency cx-icon
|
|
1985
|
+
*
|
|
1986
|
+
* @slot - The details' main content.
|
|
1987
|
+
* @slot summary - The details' summary. Alternatively, you can use the `summary` attribute.
|
|
1988
|
+
* @slot expand-icon - Optional expand icon to use instead of the default. Works best with `cx-icon`.
|
|
1989
|
+
* @slot collapse-icon - Optional collapse icon to use instead of the default. Works best with `cx-icon`.
|
|
1990
|
+
*
|
|
1991
|
+
* @event cx-show - Emitted when the details opens.
|
|
1992
|
+
* @event cx-after-show - Emitted after the details opens and all animations are complete.
|
|
1993
|
+
* @event cx-hide - Emitted when the details closes.
|
|
1994
|
+
* @event cx-after-hide - Emitted after the details closes and all animations are complete.
|
|
1995
|
+
*
|
|
1996
|
+
* @csspart base - The component's base wrapper.
|
|
1997
|
+
* @csspart summary - The container that wraps the summary.
|
|
1998
|
+
* @csspart summary-icon - The container that wraps the expand/collapse icons.
|
|
1999
|
+
* @csspart content - The details content.
|
|
2000
|
+
*
|
|
2001
|
+
* @animation details.show - The animation to use when showing details. You can use `height: auto` with this animation.
|
|
2002
|
+
* @animation details.hide - The animation to use when hiding details. You can use `height: auto` with this animation.
|
|
2003
|
+
*/
|
|
2004
|
+
interface CxElementClampAttributes extends HTMLAttributes<CxElementClamp> {
|
|
2005
|
+
|
|
2006
|
+
/**
|
|
2007
|
+
* Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you
|
|
2008
|
+
* can use the `show()` and `hide()` methods and this attribute will reflect the details' open state.
|
|
2009
|
+
*/
|
|
2010
|
+
open?: boolean;
|
|
2011
|
+
/**
|
|
2012
|
+
* Disables the details so it can't be toggled.
|
|
2013
|
+
*/
|
|
2014
|
+
disabled?: boolean;
|
|
2015
|
+
/**
|
|
2016
|
+
* The number of elements to show before clamping.
|
|
2017
|
+
*/
|
|
2018
|
+
elements?: number;
|
|
2019
|
+
/**
|
|
2020
|
+
* The root element to use for the intersection observer.
|
|
2021
|
+
*/
|
|
2022
|
+
rootElement?: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* Whether to animate the opening and closing of the details.
|
|
2025
|
+
*/
|
|
2026
|
+
animation?: boolean;
|
|
2027
|
+
/**
|
|
2028
|
+
* Whether to show the show more button.
|
|
2029
|
+
*/
|
|
2030
|
+
showMore?: boolean;
|
|
2031
|
+
/**
|
|
2032
|
+
* The text to show on the show more button.
|
|
2033
|
+
*/
|
|
2034
|
+
showMoreText?: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* The text to show on the show less button.
|
|
2037
|
+
*/
|
|
2038
|
+
showLessText?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* The event to listen to for rerendering the component
|
|
2041
|
+
*/
|
|
2042
|
+
rerenderEvent?: string;
|
|
2043
|
+
/**
|
|
2044
|
+
* Make localization attributes reactive
|
|
2045
|
+
*/
|
|
2046
|
+
dir?: string;
|
|
2047
|
+
/**
|
|
2048
|
+
*
|
|
2049
|
+
*/
|
|
2050
|
+
lang?: string;
|
|
2051
|
+
}
|
|
2052
|
+
/**
|
|
2053
|
+
* @summary Formats a number as a human readable bytes value.
|
|
2054
|
+
*/
|
|
2055
|
+
interface CxFormatBytesAttributes extends HTMLAttributes<CxFormatBytes> {
|
|
2056
|
+
|
|
2057
|
+
/**
|
|
2058
|
+
* The number to format in bytes.
|
|
2059
|
+
*/
|
|
2060
|
+
value?: number;
|
|
2061
|
+
/**
|
|
2062
|
+
* The type of unit to display.
|
|
2063
|
+
*/
|
|
2064
|
+
unit?: 'byte' | 'bit';
|
|
2065
|
+
/**
|
|
2066
|
+
* Determines how to display the result, e.g. "100 bytes", "100 b", or "100b".
|
|
2067
|
+
*/
|
|
2068
|
+
display?: 'long' | 'short' | 'narrow';
|
|
2069
|
+
/**
|
|
2070
|
+
* Make localization attributes reactive
|
|
2071
|
+
*/
|
|
2072
|
+
dir?: string;
|
|
2073
|
+
/**
|
|
2074
|
+
*
|
|
2075
|
+
*/
|
|
2076
|
+
lang?: string;
|
|
2077
|
+
}
|
|
2078
|
+
/**
|
|
2079
|
+
* @summary Formats a date/time using the specified locale and options.
|
|
2080
|
+
*/
|
|
2081
|
+
interface CxFormatDateAttributes extends HTMLAttributes<CxFormatDate> {
|
|
2082
|
+
|
|
2083
|
+
/**
|
|
2084
|
+
* The date/time to format. If not set, the current date and time will be used. When passing a string, it's strongly
|
|
2085
|
+
* recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format
|
|
2086
|
+
* in JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
|
|
2087
|
+
*/
|
|
2088
|
+
date?: string;
|
|
2089
|
+
/**
|
|
2090
|
+
* The format for displaying the weekday.
|
|
2091
|
+
*/
|
|
2092
|
+
weekday?: 'long' | 'short' | 'narrow';
|
|
2093
|
+
/**
|
|
2094
|
+
* The format for displaying the era.
|
|
2095
|
+
*/
|
|
2096
|
+
era?: 'long' | 'short' | 'narrow';
|
|
2097
|
+
/**
|
|
2098
|
+
* The format for displaying the year.
|
|
2099
|
+
*/
|
|
2100
|
+
year?: 'numeric' | '2-digit';
|
|
2101
|
+
/**
|
|
2102
|
+
* The format for displaying the month.
|
|
2103
|
+
*/
|
|
2104
|
+
month?: 'numeric' | 'long' | 'short' | 'narrow' | '2-digit';
|
|
2105
|
+
/**
|
|
2106
|
+
* The format for displaying the day.
|
|
2107
|
+
*/
|
|
2108
|
+
day?: 'numeric' | '2-digit';
|
|
2109
|
+
/**
|
|
2110
|
+
* The format for displaying the hour.
|
|
2111
|
+
*/
|
|
2112
|
+
hour?: 'numeric' | '2-digit';
|
|
2113
|
+
/**
|
|
2114
|
+
* The format for displaying the minute.
|
|
2115
|
+
*/
|
|
2116
|
+
minute?: 'numeric' | '2-digit';
|
|
2117
|
+
/**
|
|
2118
|
+
* The format for displaying the second.
|
|
2119
|
+
*/
|
|
2120
|
+
second?: 'numeric' | '2-digit';
|
|
2121
|
+
/**
|
|
2122
|
+
* The format for displaying the time.
|
|
2123
|
+
*/
|
|
2124
|
+
timeZoneName?: 'long' | 'short';
|
|
2125
|
+
/**
|
|
2126
|
+
* The time zone to express the time in.
|
|
2127
|
+
*/
|
|
2128
|
+
timeZone?: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* The format for displaying the hour.
|
|
2131
|
+
*/
|
|
2132
|
+
hourFormat?: 'auto' | '12' | '24';
|
|
2133
|
+
/**
|
|
2134
|
+
* Make localization attributes reactive
|
|
2135
|
+
*/
|
|
2136
|
+
dir?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
*
|
|
2139
|
+
*/
|
|
2140
|
+
lang?: string;
|
|
2141
|
+
}
|
|
2142
|
+
/**
|
|
2143
|
+
* @summary Formats a number using the specified locale and options.
|
|
2144
|
+
*/
|
|
2145
|
+
interface CxFormatNumberAttributes extends HTMLAttributes<CxFormatNumber> {
|
|
2146
|
+
|
|
2147
|
+
/**
|
|
2148
|
+
* The number to format.
|
|
2149
|
+
*/
|
|
2150
|
+
value?: number;
|
|
2151
|
+
/**
|
|
2152
|
+
* The formatting style to use.
|
|
2153
|
+
*/
|
|
2154
|
+
type?: 'decimal' | 'currency' | 'percent';
|
|
2155
|
+
/**
|
|
2156
|
+
* Turns off grouping separators.
|
|
2157
|
+
*/
|
|
2158
|
+
noGrouping?: boolean;
|
|
2159
|
+
/**
|
|
2160
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use when formatting.
|
|
2161
|
+
*/
|
|
2162
|
+
currency?: string;
|
|
2163
|
+
/**
|
|
2164
|
+
* How to display the currency.
|
|
2165
|
+
*/
|
|
2166
|
+
currencyDisplay?: 'symbol' | 'code' | 'name' | 'narrowSymbol';
|
|
2167
|
+
/**
|
|
2168
|
+
* The minimum number of integer digits to use. Possible values are 1-21.
|
|
2169
|
+
*/
|
|
2170
|
+
minimumIntegerDigits?: number;
|
|
2171
|
+
/**
|
|
2172
|
+
* The minimum number of fraction digits to use. Possible values are 0-20.
|
|
2173
|
+
*/
|
|
2174
|
+
minimumFractionDigits?: number;
|
|
2175
|
+
/**
|
|
2176
|
+
* The maximum number of fraction digits to use. Possible values are 0-0.
|
|
2177
|
+
*/
|
|
2178
|
+
maximumFractionDigits?: number;
|
|
2179
|
+
/**
|
|
2180
|
+
* The minimum number of significant digits to use. Possible values are 1-21.
|
|
2181
|
+
*/
|
|
2182
|
+
minimumSignificantDigits?: number;
|
|
2183
|
+
/**
|
|
2184
|
+
* The maximum number of significant digits to use,. Possible values are 1-21.
|
|
2185
|
+
*/
|
|
2186
|
+
maximumSignificantDigits?: number;
|
|
2187
|
+
/**
|
|
2188
|
+
* Make localization attributes reactive
|
|
2189
|
+
*/
|
|
2190
|
+
dir?: string;
|
|
2191
|
+
/**
|
|
2192
|
+
*
|
|
2193
|
+
*/
|
|
2194
|
+
lang?: string;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* @summary The `cx-hub-connection` component is used to establish a connection to a SignalR hub.
|
|
2198
|
+
* https://learn.microsoft.com/en-us/javascript/api/%40microsoft/signalr/hubconnection?view=signalr-js-latest
|
|
2199
|
+
*/
|
|
2200
|
+
interface CxHubConnectionAttributes extends HTMLAttributes<CxHubConnection> {
|
|
2201
|
+
|
|
2202
|
+
/**
|
|
2203
|
+
* The url of the HubConnection to the server.
|
|
2204
|
+
*/
|
|
2205
|
+
baseUrl?: string;
|
|
2206
|
+
/**
|
|
2207
|
+
* Default interval at which to ping the server in milliseconds.
|
|
2208
|
+
*/
|
|
2209
|
+
keepAliveIntervalInMilliseconds?: number;
|
|
2210
|
+
/**
|
|
2211
|
+
* A boolean value that determines whether the negotiation step should be skipped when connecting to the server.
|
|
2212
|
+
*/
|
|
2213
|
+
skipNegotiation?: boolean;
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
*/
|
|
2217
|
+
connectMode?: 'auto' | 'manual';
|
|
2218
|
+
/**
|
|
2219
|
+
* Make localization attributes reactive
|
|
2220
|
+
*/
|
|
2221
|
+
dir?: string;
|
|
2222
|
+
/**
|
|
2223
|
+
*
|
|
2224
|
+
*/
|
|
2225
|
+
lang?: string;
|
|
2226
|
+
}
|
|
2227
|
+
/**
|
|
2228
|
+
* @summary Compare visual differences between similar photos with a sliding panel.
|
|
2229
|
+
*
|
|
2230
|
+
* @dependency cx-icon
|
|
2231
|
+
*
|
|
2232
|
+
* @slot before - The before image, an `img` or `svg` element.
|
|
2233
|
+
* @slot after - The after image, an `img` or `svg` element.
|
|
2234
|
+
* @slot handle - The icon used inside the handle.
|
|
2235
|
+
*
|
|
2236
|
+
* @event cx-change - Emitted when the position changes.
|
|
2237
|
+
*
|
|
2238
|
+
* @csspart base - The component's base wrapper.
|
|
2239
|
+
* @csspart before - The container that wraps the before image.
|
|
2240
|
+
* @csspart after - The container that wraps the after image.
|
|
2241
|
+
* @csspart divider - The divider that separates the images.
|
|
2242
|
+
* @csspart handle - The handle that the user drags to expose the after image.
|
|
2243
|
+
*
|
|
2244
|
+
* @cssproperty --divider-width - The width of the dividing line.
|
|
2245
|
+
* @cssproperty --handle-size - The size of the compare handle.
|
|
2246
|
+
*/
|
|
2247
|
+
interface CxImageComparerAttributes extends HTMLAttributes<CxImageComparer> {
|
|
2248
|
+
|
|
2249
|
+
/**
|
|
2250
|
+
* The position of the divider as a percentage.
|
|
2251
|
+
*/
|
|
2252
|
+
position?: number;
|
|
2253
|
+
/**
|
|
2254
|
+
* Make localization attributes reactive
|
|
2255
|
+
*/
|
|
2256
|
+
dir?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
*
|
|
2259
|
+
*/
|
|
2260
|
+
lang?: string;
|
|
2261
|
+
}
|
|
2262
|
+
/**
|
|
2263
|
+
* @summary Includes give you the power to embed external HTML files into the page.
|
|
2264
|
+
*
|
|
2265
|
+
* @event cx-load - Emitted when the included file is loaded.
|
|
2266
|
+
* @event {{ status: number }} cx-error - Emitted when the included file fails to load due to an error.
|
|
2267
|
+
*/
|
|
2268
|
+
interface CxIncludeAttributes extends HTMLAttributes<CxInclude> {
|
|
2269
|
+
|
|
2270
|
+
/**
|
|
2271
|
+
* The location of the HTML file to include. Be sure you trust the content you are including as it will be executed as
|
|
2272
|
+
* code and can result in XSS attacks.
|
|
2273
|
+
*/
|
|
2274
|
+
src?: string;
|
|
2275
|
+
/**
|
|
2276
|
+
* The fetch mode to use.
|
|
2277
|
+
*/
|
|
2278
|
+
mode?: 'cors' | 'no-cors' | 'same-origin';
|
|
2279
|
+
/**
|
|
2280
|
+
* Allows included scripts to be executed. Be sure you trust the content you are including as it will be executed as
|
|
2281
|
+
* code and can result in XSS attacks.
|
|
2282
|
+
*/
|
|
2283
|
+
allowScripts?: boolean;
|
|
2284
|
+
/**
|
|
2285
|
+
* Make localization attributes reactive
|
|
2286
|
+
*/
|
|
2287
|
+
dir?: string;
|
|
2288
|
+
/**
|
|
2289
|
+
*
|
|
2290
|
+
*/
|
|
2291
|
+
lang?: string;
|
|
2292
|
+
}
|
|
2293
|
+
/**
|
|
2294
|
+
* @summary Input groups can be used to group related inputs into sections.
|
|
2295
|
+
*
|
|
2296
|
+
* @slot - One or more `cx-input` elements to display in the input group.
|
|
2297
|
+
*
|
|
2298
|
+
* @csspart base - The component's base wrapper.
|
|
2299
|
+
*/
|
|
2300
|
+
interface CxInputGroupAttributes extends HTMLAttributes<CxInputGroup> {
|
|
2301
|
+
|
|
2302
|
+
/**
|
|
2303
|
+
* A label to use for the input group. This won't be displayed on the screen, but it will be announced by assistive
|
|
2304
|
+
* devices when interacting with the control and is strongly recommended.
|
|
2305
|
+
*/
|
|
2306
|
+
label?: string;
|
|
2307
|
+
/**
|
|
2308
|
+
* Make localization attributes reactive
|
|
2309
|
+
*/
|
|
2310
|
+
dir?: string;
|
|
2311
|
+
/**
|
|
2312
|
+
*
|
|
2313
|
+
*/
|
|
2314
|
+
lang?: string;
|
|
2315
|
+
}
|
|
2316
|
+
/**
|
|
2317
|
+
* @summary The Resize Observer component offers a thin, declarative interface to the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).
|
|
2318
|
+
*
|
|
2319
|
+
* @slot - One or more elements to watch for resizing.
|
|
2320
|
+
*
|
|
2321
|
+
* @event {{ entries: ResizeObserverEntry[] }} cx-resize - Emitted when the element is resized.
|
|
2322
|
+
*/
|
|
2323
|
+
interface CxResizeObserverAttributes extends HTMLAttributes<CxResizeObserver> {
|
|
2324
|
+
|
|
2325
|
+
/**
|
|
2326
|
+
* Disables the observer.
|
|
2327
|
+
*/
|
|
2328
|
+
disabled?: boolean;
|
|
2329
|
+
/**
|
|
2330
|
+
* Make localization attributes reactive
|
|
2331
|
+
*/
|
|
2332
|
+
dir?: string;
|
|
2333
|
+
/**
|
|
2334
|
+
*
|
|
2335
|
+
*/
|
|
2336
|
+
lang?: string;
|
|
2337
|
+
}
|
|
2338
|
+
/**
|
|
2339
|
+
* @summary A web component for clamping text to a specific number of lines, allowing for single or multiline ellipsis.
|
|
2340
|
+
*
|
|
2341
|
+
* @csspart content - The component's content wrapper.
|
|
2342
|
+
*/
|
|
2343
|
+
interface CxLineClampAttributes extends HTMLAttributes<CxLineClamp> {
|
|
2344
|
+
|
|
2345
|
+
/**
|
|
2346
|
+
* The number of lines to clamp the text to.
|
|
2347
|
+
*/
|
|
2348
|
+
lines?: number;
|
|
2349
|
+
/**
|
|
2350
|
+
* Whether the content is open or not.
|
|
2351
|
+
*/
|
|
2352
|
+
open?: boolean;
|
|
2353
|
+
/**
|
|
2354
|
+
* Whether to show the show more button.
|
|
2355
|
+
*/
|
|
2356
|
+
showMore?: boolean;
|
|
2357
|
+
/**
|
|
2358
|
+
* The text to show on the show more button.
|
|
2359
|
+
*/
|
|
2360
|
+
showMoreText?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* The text to show on the show less button.
|
|
2363
|
+
*/
|
|
2364
|
+
showLessText?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* The tooltip to show. When this prop is set, the component will always show a tooltip.
|
|
2367
|
+
*/
|
|
2368
|
+
tooltip?: string;
|
|
2369
|
+
/**
|
|
2370
|
+
*
|
|
2371
|
+
*/
|
|
2372
|
+
disabledTooltip?: boolean;
|
|
2373
|
+
/**
|
|
2374
|
+
*
|
|
2375
|
+
*/
|
|
2376
|
+
hoverBridge?: boolean;
|
|
2377
|
+
/**
|
|
2378
|
+
* Make localization attributes reactive
|
|
2379
|
+
*/
|
|
2380
|
+
dir?: string;
|
|
2381
|
+
/**
|
|
2382
|
+
*
|
|
2383
|
+
*/
|
|
2384
|
+
lang?: string;
|
|
2385
|
+
}
|
|
2386
|
+
/**
|
|
2387
|
+
* @summary Menu labels are used to describe a group of menu items.
|
|
2388
|
+
*
|
|
2389
|
+
* @slot - The menu label's content.
|
|
2390
|
+
*
|
|
2391
|
+
* @csspart base - The component's base wrapper.
|
|
2392
|
+
*/
|
|
2393
|
+
interface CxMenuLabelAttributes extends HTMLAttributes<CxMenuLabel> {
|
|
2394
|
+
|
|
2395
|
+
/**
|
|
2396
|
+
* Make localization attributes reactive
|
|
2397
|
+
*/
|
|
2398
|
+
dir?: string;
|
|
2399
|
+
/**
|
|
2400
|
+
*
|
|
2401
|
+
*/
|
|
2402
|
+
lang?: string;
|
|
2403
|
+
}
|
|
2404
|
+
/**
|
|
2405
|
+
* @summary Menu sections provide a mean for grouping together related menu items.
|
|
2406
|
+
*
|
|
2407
|
+
* @slot - The menu items in the section.
|
|
2408
|
+
*/
|
|
2409
|
+
interface CxMenuSectionAttributes extends HTMLAttributes<CxMenuSection> {
|
|
2410
|
+
|
|
2411
|
+
/**
|
|
2412
|
+
*
|
|
2413
|
+
*/
|
|
2414
|
+
label?: string;
|
|
2415
|
+
/**
|
|
2416
|
+
* Make localization attributes reactive
|
|
2417
|
+
*/
|
|
2418
|
+
dir?: string;
|
|
2419
|
+
/**
|
|
2420
|
+
*
|
|
2421
|
+
*/
|
|
2422
|
+
lang?: string;
|
|
2423
|
+
}
|
|
2424
|
+
/**
|
|
2425
|
+
* @summary The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).
|
|
2426
|
+
*
|
|
2427
|
+
* @event {{ mutationList: MutationRecord[] }} cx-mutation - Emitted when a mutation occurs.
|
|
2428
|
+
*
|
|
2429
|
+
* @slot - The content to watch for mutations.
|
|
2430
|
+
*/
|
|
2431
|
+
interface CxMutationObserverAttributes extends HTMLAttributes<CxMutationObserver> {
|
|
2432
|
+
|
|
2433
|
+
/**
|
|
2434
|
+
* Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.
|
|
2435
|
+
* `attr="class id title"`. To watch all attributes, use `*`.
|
|
2436
|
+
*/
|
|
2437
|
+
attr?: string;
|
|
2438
|
+
/**
|
|
2439
|
+
* Indicates whether or not the attribute's previous value should be recorded when monitoring changes.
|
|
2440
|
+
*/
|
|
2441
|
+
attrOldValue?: boolean;
|
|
2442
|
+
/**
|
|
2443
|
+
* Watches for changes to the character data contained within the node.
|
|
2444
|
+
*/
|
|
2445
|
+
charData?: boolean;
|
|
2446
|
+
/**
|
|
2447
|
+
* Indicates whether or not the previous value of the node's text should be recorded.
|
|
2448
|
+
*/
|
|
2449
|
+
charDataOldValue?: boolean;
|
|
2450
|
+
/**
|
|
2451
|
+
* Watches for the addition or removal of new child nodes.
|
|
2452
|
+
*/
|
|
2453
|
+
childList?: boolean;
|
|
2454
|
+
/**
|
|
2455
|
+
* Disables the observer.
|
|
2456
|
+
*/
|
|
2457
|
+
disabled?: boolean;
|
|
2458
|
+
/**
|
|
2459
|
+
* Make localization attributes reactive
|
|
2460
|
+
*/
|
|
2461
|
+
dir?: string;
|
|
2462
|
+
/**
|
|
2463
|
+
*
|
|
2464
|
+
*/
|
|
2465
|
+
lang?: string;
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* @summary Options define the selectable items within various form controls such as [select](?s=atoms&id=/select).
|
|
2469
|
+
*
|
|
2470
|
+
* @dependency cx-icon
|
|
2471
|
+
*
|
|
2472
|
+
* @slot - The option's label.
|
|
2473
|
+
* @slot prefix - Used to prepend an icon or similar element to the menu item.
|
|
2474
|
+
* @slot suffix - Used to append an icon or similar element to the menu item.
|
|
2475
|
+
*
|
|
2476
|
+
* @csspart checked-icon - The checked icon, an `cx-icon` element.
|
|
2477
|
+
* @csspart base - The component's base wrapper.
|
|
2478
|
+
* @csspart label - The option's label.
|
|
2479
|
+
* @csspart prefix - The container that wraps the prefix.
|
|
2480
|
+
* @csspart suffix - The container that wraps the suffix.
|
|
2481
|
+
*/
|
|
2482
|
+
interface CxOptionAttributes extends HTMLAttributes<CxOption> {
|
|
2483
|
+
|
|
2484
|
+
/**
|
|
2485
|
+
* we need this because Safari doesn't honor :hover styles while dragging The option's value. When selected, the containing form control will receive this value. The value must be unique
|
|
2486
|
+
* from other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing
|
|
2487
|
+
* multiple values.
|
|
2488
|
+
*/
|
|
2489
|
+
value?: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* Draws the option in a disabled state, preventing selection.
|
|
2492
|
+
*/
|
|
2493
|
+
disabled?: boolean;
|
|
2494
|
+
/**
|
|
2495
|
+
* Whether to show check icon prefix for selected option.
|
|
2496
|
+
*/
|
|
2497
|
+
showCheck?: boolean;
|
|
2498
|
+
/**
|
|
2499
|
+
* Make localization attributes reactive
|
|
2500
|
+
*/
|
|
2501
|
+
dir?: string;
|
|
2502
|
+
/**
|
|
2503
|
+
*
|
|
2504
|
+
*/
|
|
2505
|
+
lang?: string;
|
|
2506
|
+
}
|
|
2507
|
+
/**
|
|
2508
|
+
* @summary Tags are used as labels to organize things or to indicate a selection.
|
|
2509
|
+
*
|
|
2510
|
+
* @dependency cx-icon-button
|
|
2511
|
+
*
|
|
2512
|
+
* @slot - The tag's content.
|
|
2513
|
+
*
|
|
2514
|
+
* @event cx-remove - Emitted when the remove button is activated.
|
|
2515
|
+
*
|
|
2516
|
+
* @csspart base - The component's base wrapper.
|
|
2517
|
+
* @csspart content - The tag's content.
|
|
2518
|
+
* @csspart remove-button - The tag's remove button, an `cx-icon-button`.
|
|
2519
|
+
* @csspart remove-button__base - The remove button's exported `base` part.
|
|
2520
|
+
*/
|
|
2521
|
+
interface CxTagAttributes extends HTMLAttributes<CxTag> {
|
|
2522
|
+
|
|
2523
|
+
/**
|
|
2524
|
+
* The tag's theme variant.
|
|
2525
|
+
*/
|
|
2526
|
+
variant?: 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'text';
|
|
2527
|
+
/**
|
|
2528
|
+
* The tag's size.
|
|
2529
|
+
*/
|
|
2530
|
+
size?: 'small' | 'medium' | 'large';
|
|
2531
|
+
/**
|
|
2532
|
+
* Draws a pill-style tag with rounded edges.
|
|
2533
|
+
*/
|
|
2534
|
+
pill?: boolean;
|
|
2535
|
+
/**
|
|
2536
|
+
* Makes the tag removable and shows a remove button.
|
|
2537
|
+
*/
|
|
2538
|
+
removable?: boolean;
|
|
2539
|
+
/**
|
|
2540
|
+
* Make localization attributes reactive
|
|
2541
|
+
*/
|
|
2542
|
+
dir?: string;
|
|
2543
|
+
/**
|
|
2544
|
+
*
|
|
2545
|
+
*/
|
|
2546
|
+
lang?: string;
|
|
2547
|
+
}
|
|
2548
|
+
/**
|
|
2549
|
+
* @summary Selects allow you to choose items from a menu of predefined options.
|
|
2550
|
+
*
|
|
2551
|
+
* @dependency cx-icon
|
|
2552
|
+
* @dependency cx-popup
|
|
2553
|
+
* @dependency cx-tag
|
|
2554
|
+
*
|
|
2555
|
+
* @slot - The listbox options. Can be any HTML element, nested or not, as long as they have role="option".
|
|
2556
|
+
* However, default logic supports only `cx-option` elements. Make sure to override the default logic. See region Overridable.
|
|
2557
|
+
* You can use `cx-divider` to group items visually.
|
|
2558
|
+
* @slot label - The input's label. Alternatively, you can use the `label` attribute.
|
|
2559
|
+
* @slot prefix - Used to prepend a presentational icon or similar element to the combobox.
|
|
2560
|
+
* @slot suffix - Used to append a presentational icon or similar element to the combobox.
|
|
2561
|
+
* @slot clear-icon - An icon to use in lieu of the default clear icon.
|
|
2562
|
+
* @slot expand-icon - The icon to show when the control is expanded and collapsed. Rotates on open and close.
|
|
2563
|
+
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
2564
|
+
*
|
|
2565
|
+
* @event cx-change - Emitted when the control's value changes.
|
|
2566
|
+
* @event cx-clear - Emitted when the control's value is cleared.
|
|
2567
|
+
* @event cx-input - Emitted when the control receives input.
|
|
2568
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
2569
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
2570
|
+
* @event cx-show - Emitted when the select's menu opens.
|
|
2571
|
+
* @event cx-after-show - Emitted after the select's menu opens and all animations are complete.
|
|
2572
|
+
* @event cx-hide - Emitted when the select's menu closes.
|
|
2573
|
+
* @event cx-after-hide - Emitted after the select's menu closes and all animations are complete.
|
|
2574
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
2575
|
+
*
|
|
2576
|
+
* @csspart form-control - The form control that wraps the label, input, and help text.
|
|
2577
|
+
* @csspart form-control-label - The label's wrapper.
|
|
2578
|
+
* @csspart form-control-input - The select's wrapper.
|
|
2579
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
2580
|
+
* @csspart combobox - The container the wraps the prefix, suffix, combobox, clear icon, and expand button.
|
|
2581
|
+
* @csspart prefix - The container that wraps the prefix slot.
|
|
2582
|
+
* @csspart suffix - The container that wraps the suffix slot.
|
|
2583
|
+
* @csspart display-input - The element that displays the selected option's label, an `input` element.
|
|
2584
|
+
* @csspart listbox - The listbox container where options are slotted.
|
|
2585
|
+
* @csspart tags - The container that houses option tags when `multiselect` is used.
|
|
2586
|
+
* @csspart tag - The individual tags that represent each multiselect option.
|
|
2587
|
+
* @csspart tag__base - The tag's base part.
|
|
2588
|
+
* @csspart tag__content - The tag's content part.
|
|
2589
|
+
* @csspart tag__remove-button - The tag's remove button.
|
|
2590
|
+
* @csspart tag__remove-button__base - The tag's remove button base part.
|
|
2591
|
+
* @csspart clear-button - The clear button.
|
|
2592
|
+
* @csspart expand-icon - The container that wraps the expand icon.
|
|
2593
|
+
*/
|
|
2594
|
+
interface CxSelectAttributes extends HTMLAttributes<CxSelect> {
|
|
2595
|
+
|
|
2596
|
+
/**
|
|
2597
|
+
* The name of the select, submitted as a name/value pair with form data.
|
|
2598
|
+
*/
|
|
2599
|
+
name?: string;
|
|
2600
|
+
/**
|
|
2601
|
+
* The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the
|
|
2602
|
+
* value attribute will be a space-delimited list of values based on the options selected, and the value property will
|
|
2603
|
+
* be an array. **For this reason, values must not contain spaces.
|
|
2604
|
+
*/
|
|
2605
|
+
value?: string;
|
|
2606
|
+
/**
|
|
2607
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
2608
|
+
*/
|
|
2609
|
+
defaultValue?: string;
|
|
2610
|
+
/**
|
|
2611
|
+
* The select's size.
|
|
2612
|
+
*/
|
|
2613
|
+
size?: 'small' | 'medium' | 'large';
|
|
2614
|
+
/**
|
|
2615
|
+
* Placeholder text to show as a hint when the select is empty.
|
|
2616
|
+
*/
|
|
2617
|
+
placeholder?: string;
|
|
2618
|
+
/**
|
|
2619
|
+
* If this property is enabled the user will be able to enter a free text value without being forced to select an option from the suggested values.
|
|
2620
|
+
* Otherwise, when no value is selected, the input will be cleared.
|
|
2621
|
+
*/
|
|
2622
|
+
allowFreetext?: boolean;
|
|
2623
|
+
/**
|
|
2624
|
+
* Allows more than one option to be selected.
|
|
2625
|
+
*/
|
|
2626
|
+
multiple?: boolean;
|
|
2627
|
+
/**
|
|
2628
|
+
* The maximum number of selected options to show when `multiple` is true. After the maximum, "+n" will be shown to
|
|
2629
|
+
* indicate the number of additional items that are selected. Set to 0 to remove the limit.
|
|
2630
|
+
*/
|
|
2631
|
+
maxOptionsVisible?: number;
|
|
2632
|
+
/**
|
|
2633
|
+
* Disables the select control.
|
|
2634
|
+
*/
|
|
2635
|
+
disabled?: boolean;
|
|
2636
|
+
/**
|
|
2637
|
+
* Adds a clear button when the select is not empty.
|
|
2638
|
+
*/
|
|
2639
|
+
clearable?: boolean;
|
|
2640
|
+
/**
|
|
2641
|
+
* Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can
|
|
2642
|
+
* use the `show()` and `hide()` methods and this attribute will reflect the select's open state.
|
|
2643
|
+
*/
|
|
2644
|
+
open?: boolean;
|
|
2645
|
+
/**
|
|
2646
|
+
* Enable this option to prevent the listbox from being clipped when the component is placed inside a container with
|
|
2647
|
+
* `overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.
|
|
2648
|
+
*/
|
|
2649
|
+
hoist?: boolean;
|
|
2650
|
+
/**
|
|
2651
|
+
* By default, the select menu's width matches the select's width. Set this to true to make the menu as wide as the content. Disables the select control.
|
|
2652
|
+
*/
|
|
2653
|
+
freeWidth?: boolean;
|
|
2654
|
+
/**
|
|
2655
|
+
* The autosize padding of the listbox dropdown.
|
|
2656
|
+
*/
|
|
2657
|
+
autoSizePadding?: number;
|
|
2658
|
+
/**
|
|
2659
|
+
* Draws a filled select.
|
|
2660
|
+
*/
|
|
2661
|
+
filled?: boolean;
|
|
2662
|
+
/**
|
|
2663
|
+
* Draws a pill-style select with rounded edges.
|
|
2664
|
+
*/
|
|
2665
|
+
pill?: boolean;
|
|
2666
|
+
/**
|
|
2667
|
+
* The select's label. If you need to display HTML, use the `label` slot instead.
|
|
2668
|
+
*/
|
|
2669
|
+
label?: string;
|
|
2670
|
+
/**
|
|
2671
|
+
* The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox
|
|
2672
|
+
* inside of the viewport.
|
|
2673
|
+
*/
|
|
2674
|
+
placement?: 'top' | 'bottom';
|
|
2675
|
+
/**
|
|
2676
|
+
* The select's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
2677
|
+
*/
|
|
2678
|
+
helpText?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
2681
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
2682
|
+
* the same document or shadow root for this to work.
|
|
2683
|
+
*/
|
|
2684
|
+
form?: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* The select's required attribute.
|
|
2687
|
+
*/
|
|
2688
|
+
required?: boolean;
|
|
2689
|
+
/**
|
|
2690
|
+
* Behavior when typing into the display input
|
|
2691
|
+
* - `select` - default shoelace behavior, selects the first option that starts with the typed string
|
|
2692
|
+
* - `filter` - filters out options that do not include the typed string
|
|
2693
|
+
*/
|
|
2694
|
+
inputBehavior?: 'select' | 'filter';
|
|
2695
|
+
/**
|
|
2696
|
+
*
|
|
2697
|
+
*/
|
|
2698
|
+
stayOpenOnSelect?: boolean;
|
|
2699
|
+
/**
|
|
2700
|
+
* Make localization attributes reactive
|
|
2701
|
+
*/
|
|
2702
|
+
dir?: string;
|
|
2703
|
+
/**
|
|
2704
|
+
*
|
|
2705
|
+
*/
|
|
2706
|
+
lang?: string;
|
|
2707
|
+
}
|
|
2708
|
+
/**
|
|
2709
|
+
* @summary A tree item serves as a hierarchical node that lives inside a [tree](?s=atoms&id=/tree).
|
|
2710
|
+
*
|
|
2711
|
+
* @dependency cx-checkbox
|
|
2712
|
+
* @dependency cx-icon
|
|
2713
|
+
* @dependency cx-spinner
|
|
2714
|
+
*
|
|
2715
|
+
* @event cx-expand - Emitted when the tree item expands.
|
|
2716
|
+
* @event cx-after-expand - Emitted after the tree item expands and all animations are complete.
|
|
2717
|
+
* @event cx-collapse - Emitted when the tree item collapses.
|
|
2718
|
+
* @event cx-after-collapse - Emitted after the tree item collapses and all animations are complete.
|
|
2719
|
+
* @event cx-lazy-change - Emitted when the tree item's lazy state changes.
|
|
2720
|
+
* @event cx-lazy-load - Emitted when a lazy item is selected. Use this event to asynchronously load data and append
|
|
2721
|
+
* items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading
|
|
2722
|
+
* state and update the tree.
|
|
2723
|
+
*
|
|
2724
|
+
* @slot - The default slot.
|
|
2725
|
+
* @slot expand-icon - The icon to show when the tree item is expanded.
|
|
2726
|
+
* @slot collapse-icon - The icon to show when the tree item is collapsed.
|
|
2727
|
+
*
|
|
2728
|
+
* @csspart base - The component's base wrapper.
|
|
2729
|
+
* @csspart item - The tree item's container. This element wraps everything except slotted tree item children.
|
|
2730
|
+
* @csspart item--disabled - Applied when the tree item is disabled.
|
|
2731
|
+
* @csspart item--expanded - Applied when the tree item is expanded.
|
|
2732
|
+
* @csspart item--indeterminate - Applied when the selection is indeterminate.
|
|
2733
|
+
* @csspart item--selected - Applied when the tree item is selected.
|
|
2734
|
+
* @csspart indentation - The tree item's indentation container.
|
|
2735
|
+
* @csspart expand-button - The container that wraps the tree item's expand button and spinner.
|
|
2736
|
+
* @csspart label - The tree item's label.
|
|
2737
|
+
* @csspart children - The container that wraps the tree item's nested children.
|
|
2738
|
+
* @csspart checkbox - The checkbox that shows when using multiselect.
|
|
2739
|
+
* @csspart checkbox__base - The checkbox's exported `base` part.
|
|
2740
|
+
* @csspart checkbox__control - The checkbox's exported `control` part.
|
|
2741
|
+
* @csspart checkbox__control--checked - The checkbox's exported `control--checked` part.
|
|
2742
|
+
* @csspart checkbox__control--indeterminate - The checkbox's exported `control--indeterminate` part.
|
|
2743
|
+
* @csspart checkbox__checked-icon - The checkbox's exported `checked-icon` part.
|
|
2744
|
+
* @csspart checkbox__indeterminate-icon - The checkbox's exported `indeterminate-icon` part.
|
|
2745
|
+
* @csspart checkbox__label - The checkbox's exported `label` part.
|
|
2746
|
+
*/
|
|
2747
|
+
interface CxTreeItemAttributes extends HTMLAttributes<CxTreeItem> {
|
|
2748
|
+
|
|
2749
|
+
/**
|
|
2750
|
+
* Expands the tree item.
|
|
2751
|
+
*/
|
|
2752
|
+
expanded?: boolean;
|
|
2753
|
+
/**
|
|
2754
|
+
* Draws the tree item in a selected state.
|
|
2755
|
+
*/
|
|
2756
|
+
selected?: boolean;
|
|
2757
|
+
/**
|
|
2758
|
+
* Disables the tree item.
|
|
2759
|
+
*/
|
|
2760
|
+
disabled?: boolean;
|
|
2761
|
+
/**
|
|
2762
|
+
* Makes the tree item readonly
|
|
2763
|
+
*/
|
|
2764
|
+
readonly?: boolean;
|
|
2765
|
+
/**
|
|
2766
|
+
* Enables lazy loading behavior.
|
|
2767
|
+
*/
|
|
2768
|
+
lazy?: boolean;
|
|
2769
|
+
/**
|
|
2770
|
+
* Make localization attributes reactive
|
|
2771
|
+
*/
|
|
2772
|
+
dir?: string;
|
|
2773
|
+
/**
|
|
2774
|
+
*
|
|
2775
|
+
*/
|
|
2776
|
+
lang?: string;
|
|
2777
|
+
}
|
|
2778
|
+
/**
|
|
2779
|
+
* @summary Pagination component displays the current page and allows the user to navigate through pages.
|
|
2780
|
+
*
|
|
2781
|
+
*
|
|
2782
|
+
* @dependency cx-icon-button
|
|
2783
|
+
* @dependency cx-option
|
|
2784
|
+
* @dependency cx-select
|
|
2785
|
+
* @dependency cx-typography
|
|
2786
|
+
*
|
|
2787
|
+
*
|
|
2788
|
+
* @event {{ pageIndex: number, rowsPerPage: number }} cx-page-change - Emitted when the active page changes.
|
|
2789
|
+
*/
|
|
2790
|
+
interface CxPaginationAttributes extends HTMLAttributes<CxPagination> {
|
|
2791
|
+
|
|
2792
|
+
/**
|
|
2793
|
+
* The total number of items
|
|
2794
|
+
*/
|
|
2795
|
+
count?: number;
|
|
2796
|
+
/**
|
|
2797
|
+
* The options for the number of items per page
|
|
2798
|
+
*/
|
|
2799
|
+
rowsPerPageOptions?: number[];
|
|
2800
|
+
/**
|
|
2801
|
+
* The current number of items per page
|
|
2802
|
+
*/
|
|
2803
|
+
rowsPerPage?: number;
|
|
2804
|
+
/**
|
|
2805
|
+
*
|
|
2806
|
+
*/
|
|
2807
|
+
label?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* Make localization attributes reactive
|
|
2810
|
+
*/
|
|
2811
|
+
dir?: string;
|
|
2812
|
+
/**
|
|
2813
|
+
*
|
|
2814
|
+
*/
|
|
2815
|
+
lang?: string;
|
|
2816
|
+
}
|
|
2817
|
+
/**
|
|
2818
|
+
* @summary Progress bars are used to show the status of an ongoing operation.
|
|
2819
|
+
*
|
|
2820
|
+
* @slot - A label to show inside the progress indicator.
|
|
2821
|
+
*
|
|
2822
|
+
* @csspart base - The component's base wrapper.
|
|
2823
|
+
* @csspart indicator - The progress bar's indicator.
|
|
2824
|
+
* @csspart label - The progress bar's label.
|
|
2825
|
+
*
|
|
2826
|
+
* @cssproperty --height - The progress bar's height.
|
|
2827
|
+
* @cssproperty --track-color - The color of the track.
|
|
2828
|
+
* @cssproperty --indicator-color - The color of the indicator.
|
|
2829
|
+
* @cssproperty --label-color - The color of the label.
|
|
2830
|
+
*/
|
|
2831
|
+
interface CxProgressBarAttributes extends HTMLAttributes<CxProgressBar> {
|
|
2832
|
+
|
|
2833
|
+
/**
|
|
2834
|
+
* The current progress as a percentage, 0 to 100.
|
|
2835
|
+
*/
|
|
2836
|
+
value?: number;
|
|
2837
|
+
/**
|
|
2838
|
+
* When true, percentage is ignored, the label is hidden, and the progress bar is drawn in an indeterminate state.
|
|
2839
|
+
*/
|
|
2840
|
+
indeterminate?: boolean;
|
|
2841
|
+
/**
|
|
2842
|
+
* The title of the progress bar.
|
|
2843
|
+
*/
|
|
2844
|
+
label?: string;
|
|
2845
|
+
/**
|
|
2846
|
+
* When true, the percentage is drawn.
|
|
2847
|
+
*/
|
|
2848
|
+
showProgress?: string;
|
|
2849
|
+
/**
|
|
2850
|
+
* Make localization attributes reactive
|
|
2851
|
+
*/
|
|
2852
|
+
dir?: string;
|
|
2853
|
+
/**
|
|
2854
|
+
*
|
|
2855
|
+
*/
|
|
2856
|
+
lang?: string;
|
|
2857
|
+
}
|
|
2858
|
+
/**
|
|
2859
|
+
* @summary Progress rings are used to show the progress of a determinate operation in a circular fashion.
|
|
2860
|
+
*
|
|
2861
|
+
* @slot - A label to show inside the ring.
|
|
2862
|
+
*
|
|
2863
|
+
* @csspart base - The component's base wrapper.
|
|
2864
|
+
* @csspart label - The progress ring label.
|
|
2865
|
+
*
|
|
2866
|
+
* @cssproperty --size - The diameter of the progress ring (cannot be a percentage).
|
|
2867
|
+
* @cssproperty --track-width - The width of the track.
|
|
2868
|
+
* @cssproperty --track-color - The color of the track.
|
|
2869
|
+
* @cssproperty --indicator-width - The width of the indicator. Defaults to the track width.
|
|
2870
|
+
* @cssproperty --indicator-color - The color of the indicator.
|
|
2871
|
+
* @cssproperty --indicator-transition-duration - The duration of the indicator's transition when the value changes.
|
|
2872
|
+
*/
|
|
2873
|
+
interface CxProgressRingAttributes extends HTMLAttributes<CxProgressRing> {
|
|
2874
|
+
|
|
2875
|
+
/**
|
|
2876
|
+
* The current progress as a percentage, 0 to 100.
|
|
2877
|
+
*/
|
|
2878
|
+
value?: number;
|
|
2879
|
+
/**
|
|
2880
|
+
* A custom label for assistive devices.
|
|
2881
|
+
*/
|
|
2882
|
+
label?: string;
|
|
2883
|
+
/**
|
|
2884
|
+
* Make localization attributes reactive
|
|
2885
|
+
*/
|
|
2886
|
+
dir?: string;
|
|
2887
|
+
/**
|
|
2888
|
+
*
|
|
2889
|
+
*/
|
|
2890
|
+
lang?: string;
|
|
2891
|
+
}
|
|
2892
|
+
/**
|
|
2893
|
+
* @summary Generates a [QR code](https://www.qrcode.com/) and renders it using the [Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API).
|
|
2894
|
+
*
|
|
2895
|
+
* @csspart base - The component's base wrapper.
|
|
2896
|
+
*/
|
|
2897
|
+
interface CxQrCodeAttributes extends HTMLAttributes<CxQrCode> {
|
|
2898
|
+
|
|
2899
|
+
/**
|
|
2900
|
+
* The QR code's value.
|
|
2901
|
+
*/
|
|
2902
|
+
value?: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* The label for assistive devices to announce. If unspecified, the value will be used instead.
|
|
2905
|
+
*/
|
|
2906
|
+
label?: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* The size of the QR code, in pixels.
|
|
2909
|
+
*/
|
|
2910
|
+
size?: number;
|
|
2911
|
+
/**
|
|
2912
|
+
* The fill color. This can be any valid CSS color, but not a CSS custom property.
|
|
2913
|
+
*/
|
|
2914
|
+
fill?: string;
|
|
2915
|
+
/**
|
|
2916
|
+
* The background color. This can be any valid CSS color or `transparent`. It cannot be a CSS custom property.
|
|
2917
|
+
*/
|
|
2918
|
+
background?: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* The edge radius of each module. Must be between 0 and 0.5.
|
|
2921
|
+
*/
|
|
2922
|
+
radius?: number;
|
|
2923
|
+
/**
|
|
2924
|
+
* The level of error correction to use. [Learn more](https://www.qrcode.com/en/about/error_correction.html)
|
|
2925
|
+
*/
|
|
2926
|
+
errorCorrection?: 'L' | 'M' | 'Q' | 'H';
|
|
2927
|
+
/**
|
|
2928
|
+
* Make localization attributes reactive
|
|
2929
|
+
*/
|
|
2930
|
+
dir?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
*
|
|
2933
|
+
*/
|
|
2934
|
+
lang?: string;
|
|
2935
|
+
}
|
|
2936
|
+
/**
|
|
2937
|
+
* @summary Radios allow the user to select a single option from a group.
|
|
2938
|
+
*
|
|
2939
|
+
* @dependency cx-icon
|
|
2940
|
+
*
|
|
2941
|
+
* @slot - The radio's label.
|
|
2942
|
+
*
|
|
2943
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
2944
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
2945
|
+
*
|
|
2946
|
+
* @csspart base - The component's base wrapper.
|
|
2947
|
+
* @csspart control - The circular container that wraps the radio's checked state.
|
|
2948
|
+
* @csspart control--checked - The radio control when the radio is checked.
|
|
2949
|
+
* @csspart checked-icon - The checked icon, an `cx-icon` element.
|
|
2950
|
+
* @csspart label - The container that wraps the radio's label.
|
|
2951
|
+
*/
|
|
2952
|
+
interface CxRadioAttributes extends HTMLAttributes<CxRadio> {
|
|
2953
|
+
|
|
2954
|
+
/**
|
|
2955
|
+
* The radio's value. When selected, the radio group will receive this value.
|
|
2956
|
+
*/
|
|
2957
|
+
value?: string;
|
|
2958
|
+
/**
|
|
2959
|
+
* The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this
|
|
2960
|
+
* attribute can typically be omitted.
|
|
2961
|
+
*/
|
|
2962
|
+
size?: 'small' | 'medium' | 'large';
|
|
2963
|
+
/**
|
|
2964
|
+
* Disables the radio.
|
|
2965
|
+
*/
|
|
2966
|
+
disabled?: boolean;
|
|
2967
|
+
/**
|
|
2968
|
+
* Make localization attributes reactive
|
|
2969
|
+
*/
|
|
2970
|
+
dir?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
*/
|
|
2974
|
+
lang?: string;
|
|
2975
|
+
}
|
|
2976
|
+
/**
|
|
2977
|
+
* @summary Radios buttons allow the user to select a single option from a group using a button-like control.
|
|
2978
|
+
*
|
|
2979
|
+
* @slot - The radio button's label.
|
|
2980
|
+
* @slot prefix - A presentational prefix icon or similar element.
|
|
2981
|
+
* @slot suffix - A presentational suffix icon or similar element.
|
|
2982
|
+
*
|
|
2983
|
+
* @event cx-blur - Emitted when the button loses focus.
|
|
2984
|
+
* @event cx-focus - Emitted when the button gains focus.
|
|
2985
|
+
*
|
|
2986
|
+
* @csspart base - The component's base wrapper.
|
|
2987
|
+
* @csspart button - The internal `button` element.
|
|
2988
|
+
* @csspart button--checked - The internal button element when the radio button is checked.
|
|
2989
|
+
* @csspart prefix - The container that wraps the prefix.
|
|
2990
|
+
* @csspart label - The container that wraps the radio button's label.
|
|
2991
|
+
* @csspart suffix - The container that wraps the suffix.
|
|
2992
|
+
*/
|
|
2993
|
+
interface CxRadioButtonAttributes extends HTMLAttributes<CxRadioButton> {
|
|
2994
|
+
|
|
2995
|
+
/**
|
|
2996
|
+
* @internal The radio button's checked state. This is exposed as an "internal" attribute so we can reflect it, making
|
|
2997
|
+
* it easier to style in button groups.
|
|
2998
|
+
*/
|
|
2999
|
+
checked?: boolean;
|
|
3000
|
+
/**
|
|
3001
|
+
* The radio's value. When selected, the radio group will receive this value.
|
|
3002
|
+
*/
|
|
3003
|
+
value?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* Disables the radio button.
|
|
3006
|
+
*/
|
|
3007
|
+
disabled?: boolean;
|
|
3008
|
+
/**
|
|
3009
|
+
* The radio button's size. When used inside a radio group, the size will be determined by the radio group's size so
|
|
3010
|
+
* this attribute can typically be omitted.
|
|
3011
|
+
*/
|
|
3012
|
+
size?: 'small' | 'medium' | 'large';
|
|
3013
|
+
/**
|
|
3014
|
+
* Draws a pill-style radio button with rounded edges.
|
|
3015
|
+
*/
|
|
3016
|
+
pill?: boolean;
|
|
3017
|
+
/**
|
|
3018
|
+
* Make localization attributes reactive
|
|
3019
|
+
*/
|
|
3020
|
+
dir?: string;
|
|
3021
|
+
/**
|
|
3022
|
+
*
|
|
3023
|
+
*/
|
|
3024
|
+
lang?: string;
|
|
3025
|
+
}
|
|
3026
|
+
/**
|
|
3027
|
+
*
|
|
3028
|
+
*/
|
|
3029
|
+
interface CxRadioCardAttributes extends HTMLAttributes<CxRadioCard> {
|
|
3030
|
+
|
|
3031
|
+
/**
|
|
3032
|
+
* The radio's value. When selected, the radio group will receive this value.
|
|
3033
|
+
*/
|
|
3034
|
+
value?: string;
|
|
3035
|
+
/**
|
|
3036
|
+
* Disables the radio.
|
|
3037
|
+
*/
|
|
3038
|
+
disabled?: boolean;
|
|
3039
|
+
/**
|
|
3040
|
+
* Make localization attributes reactive
|
|
3041
|
+
*/
|
|
3042
|
+
dir?: string;
|
|
3043
|
+
/**
|
|
3044
|
+
*
|
|
3045
|
+
*/
|
|
3046
|
+
lang?: string;
|
|
3047
|
+
}
|
|
3048
|
+
/**
|
|
3049
|
+
* @summary Radio groups are used to group multiple [radios](?s=atoms&id=/radio) or [radio buttons](?s=atoms&id=/radio-button) so they function as a single form control.
|
|
3050
|
+
*
|
|
3051
|
+
* @dependency cx-button-group
|
|
3052
|
+
*
|
|
3053
|
+
* @slot - The default slot where `cx-radio` or `cx-radio-button` elements are placed.
|
|
3054
|
+
* @slot label - The radio group's label. Required for proper accessibility. Alternatively, you can use the `label`
|
|
3055
|
+
* attribute.
|
|
3056
|
+
* @slot help-text - Text that describes how to use the radio group. Alternatively, you can use the `help-text` attribute.
|
|
3057
|
+
*
|
|
3058
|
+
* @event cx-change - Emitted when the radio group's selected value changes.
|
|
3059
|
+
* @event cx-input - Emitted when the radio group receives user input.
|
|
3060
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
3061
|
+
*
|
|
3062
|
+
* @csspart form-control - The form control that wraps the label, input, and help text.
|
|
3063
|
+
* @csspart form-control-label - The label's wrapper.
|
|
3064
|
+
* @csspart form-control-input - The input's wrapper.
|
|
3065
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
3066
|
+
* @csspart button-group - The button group that wraps radio buttons.
|
|
3067
|
+
* @csspart button-group__base - The button group's `base` part.
|
|
3068
|
+
*/
|
|
3069
|
+
interface CxRadioGroupAttributes extends HTMLAttributes<CxRadioGroup> {
|
|
3070
|
+
|
|
3071
|
+
/**
|
|
3072
|
+
* The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot
|
|
3073
|
+
* instead.
|
|
3074
|
+
*/
|
|
3075
|
+
label?: string;
|
|
3076
|
+
/**
|
|
3077
|
+
* The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
3078
|
+
*/
|
|
3079
|
+
helpText?: string;
|
|
3080
|
+
/**
|
|
3081
|
+
* The name of the radio group, submitted as a name/value pair with form data.
|
|
3082
|
+
*/
|
|
3083
|
+
name?: string;
|
|
3084
|
+
/**
|
|
3085
|
+
* The current value of the radio group, submitted as a name/value pair with form data.
|
|
3086
|
+
*/
|
|
3087
|
+
value?: string;
|
|
3088
|
+
/**
|
|
3089
|
+
* The radio group's size. This size will be applied to all child radios and radio buttons.
|
|
3090
|
+
*/
|
|
3091
|
+
size?: 'small' | 'medium' | 'large';
|
|
3092
|
+
/**
|
|
3093
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
3094
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
3095
|
+
* the same document or shadow root for this to work.
|
|
3096
|
+
*/
|
|
3097
|
+
form?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* Ensures a child radio is checked before allowing the containing form to submit.
|
|
3100
|
+
*/
|
|
3101
|
+
required?: boolean;
|
|
3102
|
+
/**
|
|
3103
|
+
* Arrange the radio buttons in a horizontal layout, making them appear side by side instead of stacked vertically.
|
|
3104
|
+
*/
|
|
3105
|
+
horizontal?: boolean;
|
|
3106
|
+
/**
|
|
3107
|
+
* This attribute specifies the number of items to be displayed per row. It is only applicable when the `horizontal` attribute is set to true.
|
|
3108
|
+
*/
|
|
3109
|
+
itemsPerRow?: number;
|
|
3110
|
+
/**
|
|
3111
|
+
* Make localization attributes reactive
|
|
3112
|
+
*/
|
|
3113
|
+
dir?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
*
|
|
3116
|
+
*/
|
|
3117
|
+
lang?: string;
|
|
3118
|
+
}
|
|
3119
|
+
/**
|
|
3120
|
+
* @summary Ranges allow the user to select a single value within a given range using a slider.
|
|
3121
|
+
*
|
|
3122
|
+
* @slot label - The range's label. Alternatively, you can use the `label` attribute.
|
|
3123
|
+
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
3124
|
+
*
|
|
3125
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
3126
|
+
* @event cx-change - Emitted when an alteration to the control's value is committed by the user.
|
|
3127
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
3128
|
+
* @event cx-input - Emitted when the control receives input.
|
|
3129
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
3130
|
+
* @event cx-drag-start - Emitted when the user starts dragging the thumb.
|
|
3131
|
+
* @event cx-drag-end - Emitted when the user stops dragging the thumb.
|
|
3132
|
+
*
|
|
3133
|
+
* @csspart form-control - The form control that wraps the label, input, and help text.
|
|
3134
|
+
* @csspart form-control-label - The label's wrapper.
|
|
3135
|
+
* @csspart form-control-input - The range's wrapper.
|
|
3136
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
3137
|
+
* @csspart base - The component's base wrapper.
|
|
3138
|
+
* @csspart input - The internal `input` element.
|
|
3139
|
+
* @csspart tooltip - The range's tooltip.
|
|
3140
|
+
*
|
|
3141
|
+
* @cssproperty --thumb-size - The size of the thumb.
|
|
3142
|
+
* @cssproperty --track-color-active - The color of the portion of the track that represents the current value.
|
|
3143
|
+
* @cssproperty --track-color-inactive - The of the portion of the track that represents the remaining value.
|
|
3144
|
+
* @cssproperty --track-height - The height of the track.
|
|
3145
|
+
* @cssproperty --track-active-offset - The point of origin of the active track.
|
|
3146
|
+
*/
|
|
3147
|
+
interface CxRangeAttributes extends HTMLAttributes<CxRange> {
|
|
3148
|
+
|
|
3149
|
+
/**
|
|
3150
|
+
* Sets the dragging state for the component. This allows us to control the style in CSS.
|
|
3151
|
+
*/
|
|
3152
|
+
state?: 'dragging' | 'idle';
|
|
3153
|
+
/**
|
|
3154
|
+
*
|
|
3155
|
+
*/
|
|
3156
|
+
title?: string;
|
|
3157
|
+
/**
|
|
3158
|
+
* make reactive to pass through The name of the range, submitted as a name/value pair with form data.
|
|
3159
|
+
*/
|
|
3160
|
+
name?: string;
|
|
3161
|
+
/**
|
|
3162
|
+
* The current value of the range, submitted as a name/value pair with form data.
|
|
3163
|
+
*/
|
|
3164
|
+
value?: number;
|
|
3165
|
+
/**
|
|
3166
|
+
* The range's label. If you need to display HTML, use the `label` slot instead.
|
|
3167
|
+
*/
|
|
3168
|
+
label?: string;
|
|
3169
|
+
/**
|
|
3170
|
+
* The range's help text. If you need to display HTML, use the help-text slot instead.
|
|
3171
|
+
*/
|
|
3172
|
+
helpText?: string;
|
|
3173
|
+
/**
|
|
3174
|
+
* Disables the range.
|
|
3175
|
+
*/
|
|
3176
|
+
disabled?: boolean;
|
|
3177
|
+
/**
|
|
3178
|
+
* The minimum acceptable value of the range.
|
|
3179
|
+
*/
|
|
3180
|
+
min?: number;
|
|
3181
|
+
/**
|
|
3182
|
+
* The maximum acceptable value of the range.
|
|
3183
|
+
*/
|
|
3184
|
+
max?: number;
|
|
3185
|
+
/**
|
|
3186
|
+
* The interval at which the range will increase and decrease.
|
|
3187
|
+
*/
|
|
3188
|
+
step?: number;
|
|
3189
|
+
/**
|
|
3190
|
+
* The preferred placement of the range's tooltip.
|
|
3191
|
+
*/
|
|
3192
|
+
tooltipPlacement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';
|
|
3193
|
+
/**
|
|
3194
|
+
* Controls when the tooltip is displayed:
|
|
3195
|
+
* - on: always displayed.
|
|
3196
|
+
* - off: never displayed.
|
|
3197
|
+
* - auto: displayed on hover or focus.
|
|
3198
|
+
*/
|
|
3199
|
+
tooltipDisplay?: 'auto' | 'on' | 'off';
|
|
3200
|
+
/**
|
|
3201
|
+
* Controls the `hoist` attribute of the tooltip.
|
|
3202
|
+
*/
|
|
3203
|
+
tooltipHoist?: boolean;
|
|
3204
|
+
/**
|
|
3205
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
3206
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
3207
|
+
* the same document or shadow root for this to work.
|
|
3208
|
+
*/
|
|
3209
|
+
form?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* How close the thumb must be to a mark until snapping occurs.
|
|
3212
|
+
*/
|
|
3213
|
+
snapThreshold?: number;
|
|
3214
|
+
/**
|
|
3215
|
+
* Displays a tick mark for each step in the range. If no `marks` slot is provided, marks will be auto-generated using the `step` value.
|
|
3216
|
+
*/
|
|
3217
|
+
showMarks?: boolean;
|
|
3218
|
+
/**
|
|
3219
|
+
* The offset of the tooltip from the thumb.
|
|
3220
|
+
*/
|
|
3221
|
+
tooltipOffset?: number;
|
|
3222
|
+
/**
|
|
3223
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
3224
|
+
*/
|
|
3225
|
+
defaultValue?: number;
|
|
3226
|
+
/**
|
|
3227
|
+
* Make localization attributes reactive
|
|
3228
|
+
*/
|
|
3229
|
+
dir?: string;
|
|
3230
|
+
/**
|
|
3231
|
+
*
|
|
3232
|
+
*/
|
|
3233
|
+
lang?: string;
|
|
3234
|
+
}
|
|
3235
|
+
/**
|
|
3236
|
+
* @summary Ratings give users a way to quickly view and provide feedback.
|
|
3237
|
+
*
|
|
3238
|
+
* @dependency cx-icon
|
|
3239
|
+
*
|
|
3240
|
+
* @event cx-change - Emitted when the rating's value changes.
|
|
3241
|
+
* @event {{ phase: 'start' | 'move' | 'end', value: number }} cx-hover - Emitted when the user hovers over a value. The
|
|
3242
|
+
* `phase` property indicates when hovering starts, moves to a new value, or ends. The `value` property tells what the
|
|
3243
|
+
* rating's value would be if the user were to commit to the hovered value.
|
|
3244
|
+
*
|
|
3245
|
+
* @csspart base - The component's base wrapper.
|
|
3246
|
+
*
|
|
3247
|
+
* @cssproperty --symbol-color - The inactive color for symbols.
|
|
3248
|
+
* @cssproperty --symbol-color-active - The active color for symbols.
|
|
3249
|
+
* @cssproperty --symbol-size - The size of symbols.
|
|
3250
|
+
* @cssproperty --symbol-spacing - The spacing to use around symbols.
|
|
3251
|
+
*/
|
|
3252
|
+
interface CxRatingAttributes extends HTMLAttributes<CxRating> {
|
|
3253
|
+
|
|
3254
|
+
/**
|
|
3255
|
+
* A label that describes the rating to assistive devices.
|
|
3256
|
+
*/
|
|
3257
|
+
label?: string;
|
|
3258
|
+
/**
|
|
3259
|
+
* The current rating.
|
|
3260
|
+
*/
|
|
3261
|
+
value?: number;
|
|
3262
|
+
/**
|
|
3263
|
+
* The highest rating to show.
|
|
3264
|
+
*/
|
|
3265
|
+
max?: number;
|
|
3266
|
+
/**
|
|
3267
|
+
* The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this
|
|
3268
|
+
* attribute to `0.5`.
|
|
3269
|
+
*/
|
|
3270
|
+
precision?: number;
|
|
3271
|
+
/**
|
|
3272
|
+
* Makes the rating readonly.
|
|
3273
|
+
*/
|
|
3274
|
+
readonly?: boolean;
|
|
3275
|
+
/**
|
|
3276
|
+
* Disables the rating.
|
|
3277
|
+
*/
|
|
3278
|
+
disabled?: boolean;
|
|
3279
|
+
/**
|
|
3280
|
+
* Make localization attributes reactive
|
|
3281
|
+
*/
|
|
3282
|
+
dir?: string;
|
|
3283
|
+
/**
|
|
3284
|
+
*
|
|
3285
|
+
*/
|
|
3286
|
+
lang?: string;
|
|
3287
|
+
}
|
|
3288
|
+
/**
|
|
3289
|
+
* @summary Outputs a localized time phrase relative to the current date and time.
|
|
3290
|
+
*/
|
|
3291
|
+
interface CxRelativeTimeAttributes extends HTMLAttributes<CxRelativeTime> {
|
|
3292
|
+
|
|
3293
|
+
/**
|
|
3294
|
+
* The date from which to calculate time from. If not set, the current date and time will be used. When passing a
|
|
3295
|
+
* string, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert
|
|
3296
|
+
* a date to this format in JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
|
|
3297
|
+
*/
|
|
3298
|
+
date?: string;
|
|
3299
|
+
/**
|
|
3300
|
+
* The formatting style to use.
|
|
3301
|
+
*/
|
|
3302
|
+
format?: 'long' | 'short' | 'narrow';
|
|
3303
|
+
/**
|
|
3304
|
+
* When `auto`, values such as "yesterday" and "tomorrow" will be shown when possible. When `always`, values such as
|
|
3305
|
+
* "1 day ago" and "in 1 day" will be shown.
|
|
3306
|
+
*/
|
|
3307
|
+
numeric?: 'auto' | 'always';
|
|
3308
|
+
/**
|
|
3309
|
+
* Keep the displayed value up to date as time passes.
|
|
3310
|
+
*/
|
|
3311
|
+
sync?: boolean;
|
|
3312
|
+
/**
|
|
3313
|
+
* Make localization attributes reactive
|
|
3314
|
+
*/
|
|
3315
|
+
dir?: string;
|
|
3316
|
+
/**
|
|
3317
|
+
*
|
|
3318
|
+
*/
|
|
3319
|
+
lang?: string;
|
|
3320
|
+
}
|
|
3321
|
+
/**
|
|
3322
|
+
* @summary Skeletons are used to provide a visual representation of where content will eventually be drawn.
|
|
3323
|
+
*
|
|
3324
|
+
* @csspart base - The component's base wrapper.
|
|
3325
|
+
* @csspart indicator - The skeleton's indicator which is responsible for its color and animation.
|
|
3326
|
+
*
|
|
3327
|
+
* @cssproperty --border-radius - The skeleton's border radius.
|
|
3328
|
+
* @cssproperty --color - The color of the skeleton.
|
|
3329
|
+
* @cssproperty --sheen-color - The sheen color when the skeleton is in its loading state.
|
|
3330
|
+
*/
|
|
3331
|
+
interface CxSkeletonAttributes extends HTMLAttributes<CxSkeleton> {
|
|
3332
|
+
|
|
3333
|
+
/**
|
|
3334
|
+
* Determines which effect the skeleton will use.
|
|
3335
|
+
*/
|
|
3336
|
+
effect?: 'pulse' | 'none' | 'sheen';
|
|
3337
|
+
/**
|
|
3338
|
+
* Make localization attributes reactive
|
|
3339
|
+
*/
|
|
3340
|
+
dir?: string;
|
|
3341
|
+
/**
|
|
3342
|
+
*
|
|
3343
|
+
*/
|
|
3344
|
+
lang?: string;
|
|
3345
|
+
}
|
|
3346
|
+
/**
|
|
3347
|
+
* @summary SpacingContainer allows for flexible layout spacing between child elements, vertically or horizontally, with varying sizes.
|
|
3348
|
+
*
|
|
3349
|
+
* @csspart base - The component's base container, applying flex layout.
|
|
3350
|
+
*/
|
|
3351
|
+
interface CxSpaceAttributes extends HTMLAttributes<CxSpace> {
|
|
3352
|
+
|
|
3353
|
+
/**
|
|
3354
|
+
* When set, and in vertical orientation, the child elements will stretch to fill the width of the container.
|
|
3355
|
+
*/
|
|
3356
|
+
block?: boolean;
|
|
3357
|
+
/**
|
|
3358
|
+
* The direction of the spacing container. This will determine if the child elements are spaced vertically or horizontally.
|
|
3359
|
+
*/
|
|
3360
|
+
direction?: 'horizontal' | 'vertical';
|
|
3361
|
+
/**
|
|
3362
|
+
* The spacing between child elements
|
|
3363
|
+
*/
|
|
3364
|
+
spacing?: 'small' | 'medium' | 'large' | 'x-large' | '3x-small' | '2x-small' | 'x-small' | '2x-large' | '3x-large' | '4x-large';
|
|
3365
|
+
/**
|
|
3366
|
+
* The wrap behavior of the container.
|
|
3367
|
+
*/
|
|
3368
|
+
wrap?: 'wrap' | 'nowrap' | 'wrap-reverse';
|
|
3369
|
+
/**
|
|
3370
|
+
* Proxy for justify-content CSS property.
|
|
3371
|
+
*/
|
|
3372
|
+
justifyContent?: 'normal' | 'center' | 'right' | 'left' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch';
|
|
3373
|
+
/**
|
|
3374
|
+
* Proxy for align-items CSS property.
|
|
3375
|
+
*/
|
|
3376
|
+
alignItems?: 'normal' | 'center' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'stretch' | 'baseline';
|
|
3377
|
+
/**
|
|
3378
|
+
* Make localization attributes reactive
|
|
3379
|
+
*/
|
|
3380
|
+
dir?: string;
|
|
3381
|
+
/**
|
|
3382
|
+
*
|
|
3383
|
+
*/
|
|
3384
|
+
lang?: string;
|
|
3385
|
+
}
|
|
3386
|
+
/**
|
|
3387
|
+
* @summary Split panels display two adjacent panels, allowing the user to reposition them.
|
|
3388
|
+
*
|
|
3389
|
+
* @event cx-reposition - Emitted when the divider's position changes.
|
|
3390
|
+
*
|
|
3391
|
+
* @slot start - Content to place in the start panel.
|
|
3392
|
+
* @slot end - Content to place in the end panel.
|
|
3393
|
+
* @slot divider - The divider. Useful for slotting in a custom icon that renders as a handle.
|
|
3394
|
+
*
|
|
3395
|
+
* @csspart start - The start panel.
|
|
3396
|
+
* @csspart end - The end panel.
|
|
3397
|
+
* @csspart panel - Targets both the start and end panels.
|
|
3398
|
+
* @csspart divider - The divider that separates the start and end panels.
|
|
3399
|
+
*
|
|
3400
|
+
* @cssproperty [--divider-width=4px] - The width of the visible divider.
|
|
3401
|
+
* @cssproperty [--divider-hit-area=12px] - The invisible region around the divider where dragging can occur. This is
|
|
3402
|
+
* usually wider than the divider to facilitate easier dragging.
|
|
3403
|
+
* @cssproperty [--min=0] - The minimum allowed size of the primary panel.
|
|
3404
|
+
* @cssproperty [--max=100%] - The maximum allowed size of the primary panel.
|
|
3405
|
+
*/
|
|
3406
|
+
interface CxSplitPanelAttributes extends HTMLAttributes<CxSplitPanel> {
|
|
3407
|
+
|
|
3408
|
+
/**
|
|
3409
|
+
* The current position of the divider from the primary panel's edge as a percentage 0-100. Defaults to 50% of the
|
|
3410
|
+
* container's initial size.
|
|
3411
|
+
*/
|
|
3412
|
+
position?: number;
|
|
3413
|
+
/**
|
|
3414
|
+
* The current position of the divider from the primary panel's edge in pixels.
|
|
3415
|
+
*/
|
|
3416
|
+
positionInPixels?: number;
|
|
3417
|
+
/**
|
|
3418
|
+
* Draws the split panel in a vertical orientation with the start and end panels stacked.
|
|
3419
|
+
*/
|
|
3420
|
+
vertical?: boolean;
|
|
3421
|
+
/**
|
|
3422
|
+
* Disables resizing. Note that the position may still change as a result of resizing the host element.
|
|
3423
|
+
*/
|
|
3424
|
+
disabled?: boolean;
|
|
3425
|
+
/**
|
|
3426
|
+
* If no primary panel is designated, both panels will resize proportionally when the host element is resized. If a
|
|
3427
|
+
* primary panel is designated, it will maintain its size and the other panel will grow or shrink as needed when the
|
|
3428
|
+
* host element is resized.
|
|
3429
|
+
*/
|
|
3430
|
+
primary?: 'start' | 'end';
|
|
3431
|
+
/**
|
|
3432
|
+
* Sets the dragging state for the component. This allows us to control the style in CSS.
|
|
3433
|
+
*/
|
|
3434
|
+
state?: 'dragging' | 'idle';
|
|
3435
|
+
/**
|
|
3436
|
+
* One or more space-separated values at which the divider should snap. Values can be in pixels or percentages, e.g.
|
|
3437
|
+
* `"100px 50%"`.
|
|
3438
|
+
*/
|
|
3439
|
+
snap?: string;
|
|
3440
|
+
/**
|
|
3441
|
+
* How close the divider must be to a snap point until snapping occurs.
|
|
3442
|
+
*/
|
|
3443
|
+
snapThreshold?: number;
|
|
3444
|
+
/**
|
|
3445
|
+
* Make localization attributes reactive
|
|
3446
|
+
*/
|
|
3447
|
+
dir?: string;
|
|
3448
|
+
/**
|
|
3449
|
+
*
|
|
3450
|
+
*/
|
|
3451
|
+
lang?: string;
|
|
3452
|
+
}
|
|
3453
|
+
/**
|
|
3454
|
+
*
|
|
3455
|
+
*/
|
|
3456
|
+
interface CxStepAttributes extends HTMLAttributes<CxStep> {
|
|
3457
|
+
|
|
3458
|
+
/**
|
|
3459
|
+
*
|
|
3460
|
+
*/
|
|
3461
|
+
active?: boolean;
|
|
3462
|
+
/**
|
|
3463
|
+
*
|
|
3464
|
+
*/
|
|
3465
|
+
completed?: boolean;
|
|
3466
|
+
/**
|
|
3467
|
+
*
|
|
3468
|
+
*/
|
|
3469
|
+
disabled?: boolean;
|
|
3470
|
+
/**
|
|
3471
|
+
*
|
|
3472
|
+
*/
|
|
3473
|
+
readonly?: boolean;
|
|
3474
|
+
/**
|
|
3475
|
+
*
|
|
3476
|
+
*/
|
|
3477
|
+
error?: boolean;
|
|
3478
|
+
/**
|
|
3479
|
+
*
|
|
3480
|
+
*/
|
|
3481
|
+
index?: number;
|
|
3482
|
+
/**
|
|
3483
|
+
*
|
|
3484
|
+
*/
|
|
3485
|
+
last?: boolean;
|
|
3486
|
+
/**
|
|
3487
|
+
*
|
|
3488
|
+
*/
|
|
3489
|
+
helpText?: string;
|
|
3490
|
+
/**
|
|
3491
|
+
*
|
|
3492
|
+
*/
|
|
3493
|
+
progress?: number;
|
|
3494
|
+
/**
|
|
3495
|
+
*
|
|
3496
|
+
*/
|
|
3497
|
+
color?: string;
|
|
3498
|
+
/**
|
|
3499
|
+
*
|
|
3500
|
+
*/
|
|
3501
|
+
round?: boolean;
|
|
3502
|
+
/**
|
|
3503
|
+
* Make localization attributes reactive
|
|
3504
|
+
*/
|
|
3505
|
+
dir?: string;
|
|
3506
|
+
/**
|
|
3507
|
+
*
|
|
3508
|
+
*/
|
|
3509
|
+
lang?: string;
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
*
|
|
3513
|
+
*/
|
|
3514
|
+
interface CxStepperAttributes extends HTMLAttributes<CxStepper> {
|
|
3515
|
+
|
|
3516
|
+
/**
|
|
3517
|
+
*
|
|
3518
|
+
*/
|
|
3519
|
+
direction?: 'horizontal' | 'vertical';
|
|
3520
|
+
/**
|
|
3521
|
+
*
|
|
3522
|
+
*/
|
|
3523
|
+
itemsPerRow?: number;
|
|
3524
|
+
/**
|
|
3525
|
+
* Make localization attributes reactive
|
|
3526
|
+
*/
|
|
3527
|
+
dir?: string;
|
|
3528
|
+
/**
|
|
3529
|
+
*
|
|
3530
|
+
*/
|
|
3531
|
+
lang?: string;
|
|
3532
|
+
}
|
|
3533
|
+
/**
|
|
3534
|
+
* @summary Switches allow the user to toggle an option on or off.
|
|
3535
|
+
*
|
|
3536
|
+
* @slot - The switch's label.
|
|
3537
|
+
* @slot help-text - Text that describes how to use the switch. Alternatively, you can use the `help-text` attribute.
|
|
3538
|
+
* @slot checked-icon - Thumb icon when the switch is checked.
|
|
3539
|
+
* @slot unchecked-icon - Thumb icon when the switch is unchecked.
|
|
3540
|
+
*
|
|
3541
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
3542
|
+
* @event cx-change - Emitted when the control's checked state changes.
|
|
3543
|
+
* @event cx-input - Emitted when the control receives input.
|
|
3544
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
3545
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
3546
|
+
*
|
|
3547
|
+
* @csspart base - The component's base wrapper.
|
|
3548
|
+
* @csspart control - The control that houses the switch's thumb.
|
|
3549
|
+
* @csspart thumb - The switch's thumb.
|
|
3550
|
+
* @csspart label - The switch's label.
|
|
3551
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
3552
|
+
*
|
|
3553
|
+
* @cssproperty --width - The width of the switch.
|
|
3554
|
+
* @cssproperty --height - The height of the switch.
|
|
3555
|
+
* @cssproperty --thumb-size - The size of the thumb.
|
|
3556
|
+
*/
|
|
3557
|
+
interface CxSwitchAttributes extends HTMLAttributes<CxSwitch> {
|
|
3558
|
+
|
|
3559
|
+
/**
|
|
3560
|
+
*
|
|
3561
|
+
*/
|
|
3562
|
+
title?: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* make reactive to pass through The name of the switch, submitted as a name/value pair with form data.
|
|
3565
|
+
*/
|
|
3566
|
+
name?: string;
|
|
3567
|
+
/**
|
|
3568
|
+
* The current value of the switch, submitted as a name/value pair with form data.
|
|
3569
|
+
*/
|
|
3570
|
+
value?: string;
|
|
3571
|
+
/**
|
|
3572
|
+
* The switch's size.
|
|
3573
|
+
*/
|
|
3574
|
+
size?: 'small' | 'medium' | 'large';
|
|
3575
|
+
/**
|
|
3576
|
+
* Disables the switch.
|
|
3577
|
+
*/
|
|
3578
|
+
disabled?: boolean;
|
|
3579
|
+
/**
|
|
3580
|
+
* Draws the switch in a checked state.
|
|
3581
|
+
*/
|
|
3582
|
+
checked?: boolean;
|
|
3583
|
+
/**
|
|
3584
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
3585
|
+
*/
|
|
3586
|
+
defaultChecked?: boolean;
|
|
3587
|
+
/**
|
|
3588
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
3589
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
3590
|
+
* the same document or shadow root for this to work.
|
|
3591
|
+
*/
|
|
3592
|
+
form?: string;
|
|
3593
|
+
/**
|
|
3594
|
+
* Makes the switch a required field.
|
|
3595
|
+
*/
|
|
3596
|
+
required?: boolean;
|
|
3597
|
+
/**
|
|
3598
|
+
* Whether to display icon on the switch's thumb.
|
|
3599
|
+
*/
|
|
3600
|
+
showIcon?: boolean;
|
|
3601
|
+
/**
|
|
3602
|
+
* The switch's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
3603
|
+
*/
|
|
3604
|
+
helpText?: string;
|
|
3605
|
+
/**
|
|
3606
|
+
* Make localization attributes reactive
|
|
3607
|
+
*/
|
|
3608
|
+
dir?: string;
|
|
3609
|
+
/**
|
|
3610
|
+
*
|
|
3611
|
+
*/
|
|
3612
|
+
lang?: string;
|
|
3613
|
+
}
|
|
3614
|
+
/**
|
|
3615
|
+
* @summary Tabs are used inside [tab groups](?s=atoms&id=/tab-group) to represent and activate [tab panels](?s=atoms&id=/tab-panel).
|
|
3616
|
+
*
|
|
3617
|
+
* @dependency cx-icon-button
|
|
3618
|
+
*
|
|
3619
|
+
* @slot - The tab's label.
|
|
3620
|
+
*
|
|
3621
|
+
* @event cx-close - Emitted when the tab is closable and the close button is activated.
|
|
3622
|
+
*
|
|
3623
|
+
* @csspart base - The component's base wrapper.
|
|
3624
|
+
* @csspart close-button - The close button, an `cx-icon-button`.
|
|
3625
|
+
* @csspart close-button__base - The close button's exported `base` part.
|
|
3626
|
+
*/
|
|
3627
|
+
interface CxTabAttributes extends HTMLAttributes<CxTab> {
|
|
3628
|
+
|
|
3629
|
+
/**
|
|
3630
|
+
* The name of the tab panel this tab is associated with. The panel must be located in the same tab group.
|
|
3631
|
+
*/
|
|
3632
|
+
panel?: string;
|
|
3633
|
+
/**
|
|
3634
|
+
* Draws the tab in an active state.
|
|
3635
|
+
*/
|
|
3636
|
+
active?: boolean;
|
|
3637
|
+
/**
|
|
3638
|
+
* Makes the tab closable and shows a close button.
|
|
3639
|
+
*/
|
|
3640
|
+
closable?: boolean;
|
|
3641
|
+
/**
|
|
3642
|
+
* Disables the tab and prevents selection.
|
|
3643
|
+
*/
|
|
3644
|
+
disabled?: boolean;
|
|
3645
|
+
/**
|
|
3646
|
+
* @internal
|
|
3647
|
+
* Need to wrap in a `@property()` otherwise CustomElement throws a "The result must not have attributes" runtime error.
|
|
3648
|
+
*/
|
|
3649
|
+
tabIndex?: number;
|
|
3650
|
+
/**
|
|
3651
|
+
* Make localization attributes reactive
|
|
3652
|
+
*/
|
|
3653
|
+
dir?: string;
|
|
3654
|
+
/**
|
|
3655
|
+
*
|
|
3656
|
+
*/
|
|
3657
|
+
lang?: string;
|
|
3658
|
+
}
|
|
3659
|
+
/**
|
|
3660
|
+
* @summary Tab panels are used inside [tab groups](?s=atoms&id=/tab-group) to display tabbed content.
|
|
3661
|
+
*
|
|
3662
|
+
* @slot - The tab panel's content.
|
|
3663
|
+
*
|
|
3664
|
+
* @csspart base - The component's base wrapper.
|
|
3665
|
+
*
|
|
3666
|
+
* @cssproperty --padding - The tab panel's padding.
|
|
3667
|
+
*/
|
|
3668
|
+
interface CxTabPanelAttributes extends HTMLAttributes<CxTabPanel> {
|
|
3669
|
+
|
|
3670
|
+
/**
|
|
3671
|
+
* The tab panel's name.
|
|
3672
|
+
*/
|
|
3673
|
+
name?: string;
|
|
3674
|
+
/**
|
|
3675
|
+
* When true, the tab panel will be shown.
|
|
3676
|
+
*/
|
|
3677
|
+
active?: boolean;
|
|
3678
|
+
/**
|
|
3679
|
+
* Make localization attributes reactive
|
|
3680
|
+
*/
|
|
3681
|
+
dir?: string;
|
|
3682
|
+
/**
|
|
3683
|
+
*
|
|
3684
|
+
*/
|
|
3685
|
+
lang?: string;
|
|
3686
|
+
}
|
|
3687
|
+
/**
|
|
3688
|
+
* @summary Tab groups organize content into a container that shows one section at a time.
|
|
3689
|
+
*
|
|
3690
|
+
* @dependency cx-icon-button
|
|
3691
|
+
*
|
|
3692
|
+
* @slot - Used for grouping tab panels in the tab group. Must be `cx-tab-panel` elements.
|
|
3693
|
+
* @slot nav - Used for grouping tabs in the tab group. Must be `cx-tab` elements.
|
|
3694
|
+
*
|
|
3695
|
+
* @event {{ name: String }} cx-tab-show - Emitted when a tab is shown.
|
|
3696
|
+
* @event {{ name: String }} cx-tab-hide - Emitted when a tab is hidden.
|
|
3697
|
+
*
|
|
3698
|
+
* @csspart base - The component's base wrapper.
|
|
3699
|
+
* @csspart nav - The tab group's navigation container where tabs are slotted in.
|
|
3700
|
+
* @csspart tabs - The container that wraps the tabs.
|
|
3701
|
+
* @csspart active-tab-indicator - The line that highlights the currently selected tab.
|
|
3702
|
+
* @csspart body - The tab group's body where tab panels are slotted in.
|
|
3703
|
+
* @csspart scroll-button - The previous/next scroll buttons that show when tabs are scrollable, an `cx-icon-button`.
|
|
3704
|
+
* @csspart scroll-button--start - The starting scroll button.
|
|
3705
|
+
* @csspart scroll-button--end - The ending scroll button.
|
|
3706
|
+
* @csspart scroll-button__base - The scroll button's exported `base` part.
|
|
3707
|
+
*
|
|
3708
|
+
* @cssproperty --indicator-color - The color of the active tab indicator.
|
|
3709
|
+
* @cssproperty --track-color - The color of the indicator's track (the line that separates tabs from panels).
|
|
3710
|
+
* @cssproperty --track-width - The width of the indicator's track (the line that separates tabs from panels).
|
|
3711
|
+
*/
|
|
3712
|
+
interface CxTabGroupAttributes extends HTMLAttributes<CxTabGroup> {
|
|
3713
|
+
|
|
3714
|
+
/**
|
|
3715
|
+
* The placement of the tabs.
|
|
3716
|
+
*/
|
|
3717
|
+
placement?: 'top' | 'bottom' | 'start' | 'end';
|
|
3718
|
+
/**
|
|
3719
|
+
* When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to
|
|
3720
|
+
* manual, the tab will receive focus but will not show until the user presses spacebar or enter.
|
|
3721
|
+
*/
|
|
3722
|
+
activation?: 'auto' | 'manual';
|
|
3723
|
+
/**
|
|
3724
|
+
* Disables the scroll arrows that appear when tabs overflow.
|
|
3725
|
+
*/
|
|
3726
|
+
noScrollControls?: boolean;
|
|
3727
|
+
/**
|
|
3728
|
+
* Prevent scroll buttons from being hidden when inactive.
|
|
3729
|
+
*/
|
|
3730
|
+
fixedScrollControls?: boolean;
|
|
3731
|
+
/**
|
|
3732
|
+
* Make localization attributes reactive
|
|
3733
|
+
*/
|
|
3734
|
+
dir?: string;
|
|
3735
|
+
/**
|
|
3736
|
+
*
|
|
3737
|
+
*/
|
|
3738
|
+
lang?: string;
|
|
3739
|
+
}
|
|
3740
|
+
/**
|
|
3741
|
+
* @summary Textareas collect data from the user and allow multiple lines of text.
|
|
3742
|
+
*
|
|
3743
|
+
* @slot label - The textarea's label. Alternatively, you can use the `label` attribute.
|
|
3744
|
+
* @slot help-text - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.
|
|
3745
|
+
*
|
|
3746
|
+
* @event cx-blur - Emitted when the control loses focus.
|
|
3747
|
+
* @event cx-change - Emitted when an alteration to the control's value is committed by the user.
|
|
3748
|
+
* @event cx-focus - Emitted when the control gains focus.
|
|
3749
|
+
* @event cx-input - Emitted when the control receives input.
|
|
3750
|
+
* @event cx-invalid - Emitted when the form control has been checked for validity and its constraints aren't satisfied.
|
|
3751
|
+
*
|
|
3752
|
+
* @csspart form-control - The form control that wraps the label, input, and help text.
|
|
3753
|
+
* @csspart form-control-label - The label's wrapper.
|
|
3754
|
+
* @csspart form-control-input - The input's wrapper.
|
|
3755
|
+
* @csspart form-control-help-text - The help text's wrapper.
|
|
3756
|
+
* @csspart base - The component's base wrapper.
|
|
3757
|
+
* @csspart textarea - The internal `textarea` control.
|
|
3758
|
+
*/
|
|
3759
|
+
interface CxTextareaAttributes extends HTMLAttributes<CxTextarea> {
|
|
3760
|
+
|
|
3761
|
+
/**
|
|
3762
|
+
*
|
|
3763
|
+
*/
|
|
3764
|
+
title?: string;
|
|
3765
|
+
/**
|
|
3766
|
+
* make reactive to pass through The name of the textarea, submitted as a name/value pair with form data.
|
|
3767
|
+
*/
|
|
3768
|
+
name?: string;
|
|
3769
|
+
/**
|
|
3770
|
+
* The current value of the textarea, submitted as a name/value pair with form data.
|
|
3771
|
+
*/
|
|
3772
|
+
value?: string;
|
|
3773
|
+
/**
|
|
3774
|
+
* The textarea's size.
|
|
3775
|
+
*/
|
|
3776
|
+
size?: 'small' | 'medium' | 'large';
|
|
3777
|
+
/**
|
|
3778
|
+
* Draws a filled textarea.
|
|
3779
|
+
*/
|
|
3780
|
+
filled?: boolean;
|
|
3781
|
+
/**
|
|
3782
|
+
* The textarea's label. If you need to display HTML, use the `label` slot instead.
|
|
3783
|
+
*/
|
|
3784
|
+
label?: string;
|
|
3785
|
+
/**
|
|
3786
|
+
* The textarea's help text. If you need to display HTML, use the `help-text` slot instead.
|
|
3787
|
+
*/
|
|
3788
|
+
helpText?: string;
|
|
3789
|
+
/**
|
|
3790
|
+
* Placeholder text to show as a hint when the input is empty.
|
|
3791
|
+
*/
|
|
3792
|
+
placeholder?: string;
|
|
3793
|
+
/**
|
|
3794
|
+
* The number of rows to display by default.
|
|
3795
|
+
*/
|
|
3796
|
+
rows?: number;
|
|
3797
|
+
/**
|
|
3798
|
+
* Controls how the textarea can be resized.
|
|
3799
|
+
*/
|
|
3800
|
+
resize?: 'none' | 'auto' | 'vertical';
|
|
3801
|
+
/**
|
|
3802
|
+
* Disables the textarea.
|
|
3803
|
+
*/
|
|
3804
|
+
disabled?: boolean;
|
|
3805
|
+
/**
|
|
3806
|
+
* Makes the textarea readonly.
|
|
3807
|
+
*/
|
|
3808
|
+
readonly?: boolean;
|
|
3809
|
+
/**
|
|
3810
|
+
* By default, form controls are associated with the nearest containing `form` element. This attribute allows you
|
|
3811
|
+
* to place the form control outside of a form and associate it with the form that has this `id`. The form must be in
|
|
3812
|
+
* the same document or shadow root for this to work.
|
|
3813
|
+
*/
|
|
3814
|
+
form?: string;
|
|
3815
|
+
/**
|
|
3816
|
+
* Makes the textarea a required field.
|
|
3817
|
+
*/
|
|
3818
|
+
required?: boolean;
|
|
3819
|
+
/**
|
|
3820
|
+
* The minimum length of input that will be considered valid.
|
|
3821
|
+
*/
|
|
3822
|
+
minlength?: number;
|
|
3823
|
+
/**
|
|
3824
|
+
* The maximum length of input that will be considered valid.
|
|
3825
|
+
*/
|
|
3826
|
+
maxlength?: number;
|
|
3827
|
+
/**
|
|
3828
|
+
* Controls whether and how text input is automatically capitalized as it is entered by the user.
|
|
3829
|
+
*/
|
|
3830
|
+
autocapitalize?: 'none' | 'on' | 'off' | 'sentences' | 'words' | 'characters';
|
|
3831
|
+
/**
|
|
3832
|
+
* Indicates whether the browser's autocorrect feature is on or off.
|
|
3833
|
+
*/
|
|
3834
|
+
autocorrect?: string;
|
|
3835
|
+
/**
|
|
3836
|
+
* Specifies what permission the browser has to provide assistance in filling out form field values. Refer to
|
|
3837
|
+
* [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.
|
|
3838
|
+
*/
|
|
3839
|
+
autocomplete?: string;
|
|
3840
|
+
/**
|
|
3841
|
+
* Indicates that the input should receive focus on page load.
|
|
3842
|
+
*/
|
|
3843
|
+
autofocus?: boolean;
|
|
3844
|
+
/**
|
|
3845
|
+
* Used to customize the label or icon of the Enter key on virtual keyboards.
|
|
3846
|
+
*/
|
|
3847
|
+
enterkeyhint?: 'search' | 'enter' | 'done' | 'go' | 'next' | 'previous' | 'send';
|
|
3848
|
+
/**
|
|
3849
|
+
* Enables spell checking on the textarea.
|
|
3850
|
+
*/
|
|
3851
|
+
spellcheck?: boolean;
|
|
3852
|
+
/**
|
|
3853
|
+
* Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual
|
|
3854
|
+
* keyboard on supportive devices.
|
|
3855
|
+
*/
|
|
3856
|
+
inputmode?: 'none' | 'text' | 'search' | 'email' | 'tel' | 'url' | 'decimal' | 'numeric';
|
|
3857
|
+
/**
|
|
3858
|
+
* The default value of the form control. Primarily used for resetting the form control.
|
|
3859
|
+
*/
|
|
3860
|
+
defaultValue?: string;
|
|
3861
|
+
/**
|
|
3862
|
+
* Make localization attributes reactive
|
|
3863
|
+
*/
|
|
3864
|
+
dir?: string;
|
|
3865
|
+
/**
|
|
3866
|
+
*
|
|
3867
|
+
*/
|
|
3868
|
+
lang?: string;
|
|
3869
|
+
}
|
|
3870
|
+
/**
|
|
3871
|
+
* @summary Trees allow you to display a hierarchical list of selectable [tree items](?s=atoms&id=/tree-item). Items with children can be expanded and collapsed as desired by the user.
|
|
3872
|
+
*
|
|
3873
|
+
* @event {{ selection: CxTreeItem[] }} cx-selection-change - Emitted when a tree item is selected or deselected.
|
|
3874
|
+
*
|
|
3875
|
+
* @slot - The default slot.
|
|
3876
|
+
* @slot expand-icon - The icon to show when the tree item is expanded. Works best with `cx-icon`.
|
|
3877
|
+
* @slot collapse-icon - The icon to show when the tree item is collapsed. Works best with `cx-icon`.
|
|
3878
|
+
*
|
|
3879
|
+
* @csspart base - The component's base wrapper.
|
|
3880
|
+
*
|
|
3881
|
+
* @cssproperty [--indent-size=var(--cx-spacing-medium)] - The size of the indentation for nested items.
|
|
3882
|
+
* @cssproperty [--indent-guide-color=var(--cx-color-neutral-200)] - The color of the indentation line.
|
|
3883
|
+
* @cssproperty [--indent-guide-offset=0] - The amount of vertical spacing to leave between the top and bottom of the
|
|
3884
|
+
* indentation line's starting position.
|
|
3885
|
+
* @cssproperty [--indent-guide-style=solid] - The style of the indentation line, e.g. solid, dotted, dashed.
|
|
3886
|
+
* @cssproperty [--indent-guide-width=0] - The width of the indentation line.
|
|
3887
|
+
*/
|
|
3888
|
+
interface CxTreeAttributes extends HTMLAttributes<CxTree> {
|
|
3889
|
+
|
|
3890
|
+
/**
|
|
3891
|
+
* The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple
|
|
3892
|
+
* displays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.
|
|
3893
|
+
*/
|
|
3894
|
+
selection?: 'single' | 'multiple' | 'leaf';
|
|
3895
|
+
/**
|
|
3896
|
+
* Indicates whether the tree checkboxes should be synced with the selected state of the tree items.
|
|
3897
|
+
* For example, when select all chilren, the parent checkbox will be checked. When parent checkbox is checked, all children will be checked.
|
|
3898
|
+
* If set to `true`, the chilren and parent checked state will be independent of each other.
|
|
3899
|
+
* This is only applicable when `selection` is set to `multiple`.
|
|
3900
|
+
*/
|
|
3901
|
+
disabledSyncCheckboxes?: boolean;
|
|
3902
|
+
/**
|
|
3903
|
+
* Make localization attributes reactive
|
|
3904
|
+
*/
|
|
3905
|
+
dir?: string;
|
|
3906
|
+
/**
|
|
3907
|
+
*
|
|
3908
|
+
*/
|
|
3909
|
+
lang?: string;
|
|
3910
|
+
}
|
|
3911
|
+
/**
|
|
3912
|
+
* @summary The responsive layout grid adapts to screen size and orientation, ensuring consistency across layouts.
|
|
3913
|
+
*
|
|
3914
|
+
* @slot - The component's main content.
|
|
3915
|
+
*
|
|
3916
|
+
* @csspart content - The component's content.
|
|
3917
|
+
*/
|
|
3918
|
+
interface CxGridAttributes extends HTMLAttributes<CxGrid> {
|
|
3919
|
+
|
|
3920
|
+
/**
|
|
3921
|
+
* The space between children.
|
|
3922
|
+
*/
|
|
3923
|
+
spacing?: string;
|
|
3924
|
+
/**
|
|
3925
|
+
* The number of columns to display.
|
|
3926
|
+
*/
|
|
3927
|
+
columns?: number;
|
|
3928
|
+
/**
|
|
3929
|
+
* Whether to use flex gap or not.
|
|
3930
|
+
*/
|
|
3931
|
+
useFlexGap?: boolean;
|
|
3932
|
+
/**
|
|
3933
|
+
* The space between columns. It overrides the value of the spacing prop.
|
|
3934
|
+
*/
|
|
3935
|
+
columnSpacing?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* The space between rows. It overrides the value of the spacing prop.
|
|
3938
|
+
*/
|
|
3939
|
+
rowSpacing?: string;
|
|
3940
|
+
/**
|
|
3941
|
+
* Defines the flex-wrap style property.
|
|
3942
|
+
*/
|
|
3943
|
+
wrap?: 'wrap' | 'nowrap' | 'wrap-reverse';
|
|
3944
|
+
/**
|
|
3945
|
+
* Whether to use the "@container" query or not.
|
|
3946
|
+
*/
|
|
3947
|
+
useContainer?: boolean;
|
|
3948
|
+
/**
|
|
3949
|
+
* Make localization attributes reactive
|
|
3950
|
+
*/
|
|
3951
|
+
dir?: string;
|
|
3952
|
+
/**
|
|
3953
|
+
*
|
|
3954
|
+
*/
|
|
3955
|
+
lang?: string;
|
|
3956
|
+
}
|
|
3957
|
+
/**
|
|
3958
|
+
* @summary The item of a Grid layout.
|
|
3959
|
+
*
|
|
3960
|
+
* @slot - The component’s's main content.
|
|
3961
|
+
*
|
|
3962
|
+
* @csspart body -The component’s content
|
|
3963
|
+
*/
|
|
3964
|
+
interface CxGridItemAttributes extends HTMLAttributes<CxGridItem> {
|
|
3965
|
+
|
|
3966
|
+
/**
|
|
3967
|
+
*
|
|
3968
|
+
*/
|
|
3969
|
+
xs?: string;
|
|
3970
|
+
/**
|
|
3971
|
+
*
|
|
3972
|
+
*/
|
|
3973
|
+
sm?: string;
|
|
3974
|
+
/**
|
|
3975
|
+
*
|
|
3976
|
+
*/
|
|
3977
|
+
md?: string;
|
|
3978
|
+
/**
|
|
3979
|
+
*
|
|
3980
|
+
*/
|
|
3981
|
+
lg?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
*
|
|
3984
|
+
*/
|
|
3985
|
+
xl?: string;
|
|
3986
|
+
/**
|
|
3987
|
+
*
|
|
3988
|
+
*/
|
|
3989
|
+
useContainer?: boolean;
|
|
3990
|
+
/**
|
|
3991
|
+
* Make localization attributes reactive
|
|
3992
|
+
*/
|
|
3993
|
+
dir?: string;
|
|
3994
|
+
/**
|
|
3995
|
+
*
|
|
3996
|
+
*/
|
|
3997
|
+
lang?: string;
|
|
3998
|
+
}
|
|
3999
|
+
/**
|
|
4000
|
+
* @summary A chatbot component to interact with Cortex AI Assistant.
|
|
4001
|
+
*
|
|
4002
|
+
* @dependency cx-tooltip
|
|
4003
|
+
* @dependency cx-icon-button
|
|
4004
|
+
* @dependency cx-markdown
|
|
4005
|
+
* @dependency cx-icon
|
|
4006
|
+
* @dependency cx-typography
|
|
4007
|
+
* @dependency cx-checkbox
|
|
4008
|
+
* @dependency cx-menu
|
|
4009
|
+
* @dependency cx-menu-item
|
|
4010
|
+
* @dependency cx-input
|
|
4011
|
+
* @dependency cx-badge
|
|
4012
|
+
* @dependency cx-dropdown
|
|
4013
|
+
* @dependency cx-button
|
|
4014
|
+
* @dependency cx-divider
|
|
4015
|
+
*/
|
|
4016
|
+
interface CxChatbotAttributes extends HTMLAttributes<CxChatbot> {
|
|
4017
|
+
|
|
4018
|
+
/**
|
|
4019
|
+
* The conversation ID to connect to the chatbot
|
|
4020
|
+
*/
|
|
4021
|
+
conversationId?: string;
|
|
4022
|
+
/**
|
|
4023
|
+
* The title of the chatbot
|
|
4024
|
+
*/
|
|
4025
|
+
conversationTitle?: string;
|
|
4026
|
+
/**
|
|
4027
|
+
* The purpose of the conversation
|
|
4028
|
+
*/
|
|
4029
|
+
conversationPurpose?: string;
|
|
4030
|
+
/**
|
|
4031
|
+
* The name of the chatbot
|
|
4032
|
+
*/
|
|
4033
|
+
botName?: string;
|
|
4034
|
+
/**
|
|
4035
|
+
* The name of the user
|
|
4036
|
+
*/
|
|
4037
|
+
userName?: string;
|
|
4038
|
+
/**
|
|
4039
|
+
* The events to show in the chatbot's menu
|
|
4040
|
+
*/
|
|
4041
|
+
events?: CxChatbotChatbotEvent[];
|
|
4042
|
+
/**
|
|
4043
|
+
* The connection URL to the chatbot
|
|
4044
|
+
*/
|
|
4045
|
+
connectionURL?: string;
|
|
4046
|
+
/**
|
|
4047
|
+
* Make localization attributes reactive
|
|
4048
|
+
*/
|
|
4049
|
+
dir?: string;
|
|
4050
|
+
/**
|
|
4051
|
+
*
|
|
4052
|
+
*/
|
|
4053
|
+
lang?: string;
|
|
4054
|
+
}
|
|
4055
|
+
/**
|
|
4056
|
+
* @summary Confirm popover is a component that displays a confirmation dialog with a message and two action buttons.
|
|
4057
|
+
*
|
|
4058
|
+
* @dependency cx-dropdown
|
|
4059
|
+
* @dependency cx-typography
|
|
4060
|
+
* @dependency cx-button
|
|
4061
|
+
*
|
|
4062
|
+
* @event cx-confirm - The confirm button was clicked.
|
|
4063
|
+
* @event cx-cancel - The cancel button was clicked.
|
|
4064
|
+
*
|
|
4065
|
+
* @slot trigger - The trigger element that opens the popover.
|
|
4066
|
+
* @slot footer - The footer element that appears below the message and action buttons.
|
|
4067
|
+
*
|
|
4068
|
+
* @csspart base - The component's base wrapper.
|
|
4069
|
+
* @csspart content - The container that wraps the popover's content.
|
|
4070
|
+
* @csspart actions - The container that wraps the action buttons.
|
|
4071
|
+
* @csspart confirm-button - The confirm button.
|
|
4072
|
+
* @csspart cancel-button - The cancel button.
|
|
4073
|
+
* @csspart footer - The container that wraps the popover's footer.
|
|
4074
|
+
*
|
|
4075
|
+
* @cssproperty --size - The size of the avatar.
|
|
4076
|
+
*/
|
|
4077
|
+
interface CxConfirmPopoverAttributes extends HTMLAttributes<CxConfirmPopover> {
|
|
4078
|
+
|
|
4079
|
+
/**
|
|
4080
|
+
* The message to display in the confirmation dialog.
|
|
4081
|
+
*/
|
|
4082
|
+
message?: string;
|
|
4083
|
+
/**
|
|
4084
|
+
* If true, when the trigger is clicked, the popover will not be shown. Instead, cx-confirm event will be emitted.
|
|
4085
|
+
*/
|
|
4086
|
+
disabled?: boolean;
|
|
4087
|
+
/**
|
|
4088
|
+
* The variant of the confirm popover. It can be either 'dialog' or 'dropdown'.
|
|
4089
|
+
*/
|
|
4090
|
+
variant?: 'dropdown' | 'dialog';
|
|
4091
|
+
/**
|
|
4092
|
+
* The strategy of the confirm popover's dropdown/dialog popup.
|
|
4093
|
+
*/
|
|
4094
|
+
strategy?: 'absolute' | 'fixed';
|
|
4095
|
+
/**
|
|
4096
|
+
* Make localization attributes reactive
|
|
4097
|
+
*/
|
|
4098
|
+
dir?: string;
|
|
4099
|
+
/**
|
|
4100
|
+
*
|
|
4101
|
+
*/
|
|
4102
|
+
lang?: string;
|
|
4103
|
+
}
|
|
4104
|
+
/**
|
|
4105
|
+
* @summary File on Demand is a component that allows users to view and manage their assets.
|
|
4106
|
+
*
|
|
4107
|
+
* @dependency cx-typography
|
|
4108
|
+
* @dependency cx-input
|
|
4109
|
+
* @dependency cx-button
|
|
4110
|
+
* @dependency cx-avatar
|
|
4111
|
+
* @dependency cx-icon-button
|
|
4112
|
+
* @dependency cx-relative-time
|
|
4113
|
+
* @dependency cx-icon
|
|
4114
|
+
* @dependency cx-tab
|
|
4115
|
+
* @dependency cx-tab-group
|
|
4116
|
+
* @dependency cx-tab-panel
|
|
4117
|
+
* @dependency cx-format-bytes
|
|
4118
|
+
* @dependency cx-progress-bar
|
|
4119
|
+
* @dependency cx-line-clamp
|
|
4120
|
+
* @dependency cx-tooltip
|
|
4121
|
+
* @dependency cx-switch
|
|
4122
|
+
* @dependency cx-select
|
|
4123
|
+
* @dependency cx-option
|
|
4124
|
+
* @dependency cx-dialog
|
|
4125
|
+
*
|
|
4126
|
+
* @event {{ assetId: string }} cx-mark-favorite - Emitted when the user marks an asset as favorite.
|
|
4127
|
+
* @event {{ assetId: string }} cx-unmark-favorite - Emitted when the user unmarks an asset as favorite.
|
|
4128
|
+
* @event cx-open-search - Emitted when the user opens the search.
|
|
4129
|
+
* @event {{ assetId: string }} cx-open-drive - Emitted when the user opens the drive.
|
|
4130
|
+
* @event {{ type: string }} cx-load-more - Emitted when the user requests more assets.
|
|
4131
|
+
* @event {{ connectUrl: string }} cx-connect - Emitted when the user requests to connect to the given connectionUrl.
|
|
4132
|
+
* @event {{ connectUrl: string }} cx-disconnect - Emitted when the user requests to disconnect from the given connectionUrl.
|
|
4133
|
+
* @event cx-clear-cache - Emitted when the user requests to clear the cache.
|
|
4134
|
+
* @event cx-import-settings - Emitted when the user requests to import settings.
|
|
4135
|
+
* @event cx-export-settings - Emitted when the user requests to export settings.
|
|
4136
|
+
* @event cx-view-logs - Emitted when the user requests to view logs.
|
|
4137
|
+
* @event cx-add-proxy-format-folders - Emitted when the user requests to add proxy format folders.
|
|
4138
|
+
* @event {{ settings: Settings }} cx-save-settings - Emitted when the user saves the settings.
|
|
4139
|
+
* @event cx-quit - Emitted when the user quits the application.
|
|
4140
|
+
* @event cx-upgrade - Emitted when the user requests to upgrade the application.
|
|
4141
|
+
*/
|
|
4142
|
+
interface CxFileOnDemandAttributes extends HTMLAttributes<CxFileOnDemand> {
|
|
4143
|
+
|
|
4144
|
+
/**
|
|
4145
|
+
* Indicates if the user is connected to the provided connection URL.
|
|
4146
|
+
*/
|
|
4147
|
+
connectionEstablished?: boolean;
|
|
4148
|
+
/**
|
|
4149
|
+
* The connection status.
|
|
4150
|
+
*/
|
|
4151
|
+
connectionStatus?: 'excellent' | 'good' | 'bad';
|
|
4152
|
+
/**
|
|
4153
|
+
* The asset index sync status.
|
|
4154
|
+
*/
|
|
4155
|
+
assetIndexSyncStatus?: 'error' | 'loading' | 'loaded';
|
|
4156
|
+
/**
|
|
4157
|
+
* The user's avatar URL.
|
|
4158
|
+
*/
|
|
4159
|
+
userAvatarUrl?: string;
|
|
4160
|
+
/**
|
|
4161
|
+
*
|
|
4162
|
+
*/
|
|
4163
|
+
username?: string;
|
|
4164
|
+
/**
|
|
4165
|
+
*
|
|
4166
|
+
*/
|
|
4167
|
+
recentAssets?: CxFileOnDemandAssetsProp;
|
|
4168
|
+
/**
|
|
4169
|
+
*
|
|
4170
|
+
*/
|
|
4171
|
+
favoriteAssets?: CxFileOnDemandAssetsProp;
|
|
4172
|
+
/**
|
|
4173
|
+
*
|
|
4174
|
+
*/
|
|
4175
|
+
uploadingAssets?: CxFileOnDemandAssetsProp;
|
|
4176
|
+
/**
|
|
4177
|
+
*
|
|
4178
|
+
*/
|
|
4179
|
+
availableFolderIdentifiers?: CxFileOnDemandFolderOption[];
|
|
4180
|
+
/**
|
|
4181
|
+
*
|
|
4182
|
+
*/
|
|
4183
|
+
settings?: CxFileOnDemandSettings;
|
|
4184
|
+
/**
|
|
4185
|
+
* Indicates if the application has a new version to upgrade to.
|
|
4186
|
+
*/
|
|
4187
|
+
hasNewVersion?: boolean;
|
|
4188
|
+
/**
|
|
4189
|
+
* The about content to display in the settings view.
|
|
4190
|
+
*/
|
|
4191
|
+
aboutContent?: string;
|
|
4192
|
+
/**
|
|
4193
|
+
* Make localization attributes reactive
|
|
4194
|
+
*/
|
|
4195
|
+
dir?: string;
|
|
4196
|
+
/**
|
|
4197
|
+
*
|
|
4198
|
+
*/
|
|
4199
|
+
lang?: string;
|
|
4200
|
+
}
|
|
4201
|
+
/**
|
|
4202
|
+
* @summary Represents a layout with up-to-2 sidebars of fixed width, and the main content takes up the rest of the available space.
|
|
4203
|
+
*
|
|
4204
|
+
* @slot - The main content.
|
|
4205
|
+
* @slot left - Left sidebar content.
|
|
4206
|
+
* @slot right - Right sidebar content.
|
|
4207
|
+
*
|
|
4208
|
+
* @csspart base - The component's base wrapper.
|
|
4209
|
+
* @csspart left-container - The container that wraps the left sidebar.
|
|
4210
|
+
* @csspart right-container - The container that wraps the right sidebar.
|
|
4211
|
+
* @csspart content - The container that wraps the main content.
|
|
4212
|
+
*/
|
|
4213
|
+
interface CxSidebarLayoutAttributes extends HTMLAttributes<CxSidebarLayout> {
|
|
4214
|
+
|
|
4215
|
+
/**
|
|
4216
|
+
* Make localization attributes reactive
|
|
4217
|
+
*/
|
|
4218
|
+
dir?: string;
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
*/
|
|
4222
|
+
lang?: string;
|
|
4223
|
+
}
|
|
4224
|
+
/**
|
|
4225
|
+
* @summary
|
|
4226
|
+
*
|
|
4227
|
+
* @event
|
|
4228
|
+
*/
|
|
4229
|
+
interface CxGraphViewAttributes extends HTMLAttributes<CxGraphView> {
|
|
4230
|
+
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
*/
|
|
4234
|
+
data?: CxGraphViewWorkflow;
|
|
4235
|
+
/**
|
|
4236
|
+
*
|
|
4237
|
+
*/
|
|
4238
|
+
readonly?: boolean;
|
|
4239
|
+
/**
|
|
4240
|
+
*
|
|
4241
|
+
*/
|
|
4242
|
+
hideControls?: boolean;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
*/
|
|
4246
|
+
renderDelay?: number;
|
|
4247
|
+
/**
|
|
4248
|
+
* Make localization attributes reactive
|
|
4249
|
+
*/
|
|
4250
|
+
dir?: string;
|
|
4251
|
+
/**
|
|
4252
|
+
*
|
|
4253
|
+
*/
|
|
4254
|
+
lang?: string;
|
|
4255
|
+
}
|
|
4256
|
+
/**
|
|
4257
|
+
*
|
|
4258
|
+
*/
|
|
4259
|
+
interface CxStepperWizardAttributes extends HTMLAttributes<CxStepperWizard> {
|
|
4260
|
+
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
*/
|
|
4264
|
+
data?: CxStepperWizardStepData[];
|
|
4265
|
+
/**
|
|
4266
|
+
*
|
|
4267
|
+
*/
|
|
4268
|
+
maxWidth?: number;
|
|
4269
|
+
/**
|
|
4270
|
+
*
|
|
4271
|
+
*/
|
|
4272
|
+
minWidth?: number;
|
|
4273
|
+
/**
|
|
4274
|
+
* Make localization attributes reactive
|
|
4275
|
+
*/
|
|
4276
|
+
dir?: string;
|
|
4277
|
+
/**
|
|
4278
|
+
*
|
|
4279
|
+
*/
|
|
4280
|
+
lang?: string;
|
|
4281
|
+
}
|
|
4282
|
+
/**
|
|
4283
|
+
* @summary Widget for managing cluster. Pure web component version of orangelogic.react.clustermanagement.
|
|
4284
|
+
*
|
|
4285
|
+
* @event cx-refresh - Emitted when a data refresh has been made.
|
|
4286
|
+
*
|
|
4287
|
+
* @csspart base - The component's base wrapper.
|
|
4288
|
+
* @csspart spinner - The spinner that gets displayed when no data is available yet.
|
|
4289
|
+
* @csspart alert - The alert that gets displayed when an error occurs.
|
|
4290
|
+
* @csspart service - The container that wraps around each service.
|
|
4291
|
+
* @csspart service__label - The label for each service.
|
|
4292
|
+
* @csspart service__range - The wrapper around each service's range sliders.
|
|
4293
|
+
* @csspart service__running-range - Each service's range slider for the currently running count.
|
|
4294
|
+
* @csspart service__desired-range - Each service's range slider for the desired count.
|
|
4295
|
+
* @csspart status - The container that wraps the status date and refresh button.
|
|
4296
|
+
* @csspart status__refresh-button - The button to refresh the data.
|
|
4297
|
+
* @csspart status__refresh-spinner - The spinner that gets displayed when data is being refreshed.
|
|
4298
|
+
* @csspart dialog - The dialog that gets displayed when confirming a change.
|
|
4299
|
+
* @csspart dialog__confirm-button - The confirm button inside the confirmation dialog.
|
|
4300
|
+
* @csspart dialog__cancel-button - The cancel button inside the confirmation dialog.
|
|
4301
|
+
*
|
|
4302
|
+
* @dependency cx-alert
|
|
4303
|
+
* @dependency cx-icon
|
|
4304
|
+
* @dependency cx-spinner
|
|
4305
|
+
* @dependency cx-range
|
|
4306
|
+
* @dependency cx-icon-button
|
|
4307
|
+
* @dependency cx-dialog
|
|
4308
|
+
* @dependency cx-format-date
|
|
4309
|
+
*/
|
|
4310
|
+
interface CxClusterManagementAttributes extends HTMLAttributes<CxClusterManagement> {
|
|
4311
|
+
|
|
4312
|
+
/**
|
|
4313
|
+
* How many seconds between each automatic data refresh
|
|
4314
|
+
*/
|
|
4315
|
+
refreshInterval?: number;
|
|
4316
|
+
/**
|
|
4317
|
+
* If true, the component is in readonly mode. No changes can be made to the service counts.
|
|
4318
|
+
*/
|
|
4319
|
+
readonly?: boolean;
|
|
4320
|
+
/**
|
|
4321
|
+
* Make localization attributes reactive
|
|
4322
|
+
*/
|
|
4323
|
+
dir?: string;
|
|
4324
|
+
/**
|
|
4325
|
+
*
|
|
4326
|
+
*/
|
|
4327
|
+
lang?: string;
|
|
4328
|
+
}
|
|
4329
|
+
/**
|
|
4330
|
+
*
|
|
4331
|
+
*/
|
|
4332
|
+
interface CxStorybookAttributes extends HTMLAttributes<CxStorybook> {
|
|
4333
|
+
|
|
4334
|
+
/**
|
|
4335
|
+
* Make localization attributes reactive
|
|
4336
|
+
*/
|
|
4337
|
+
dir?: string;
|
|
4338
|
+
/**
|
|
4339
|
+
*
|
|
4340
|
+
*/
|
|
4341
|
+
lang?: string;
|
|
4342
|
+
}
|
|
4343
|
+
/**
|
|
4344
|
+
* @summary Represents a sidebar in a sidebar layout.
|
|
4345
|
+
*
|
|
4346
|
+
* @dependency cx-divider
|
|
4347
|
+
* @dependency cx-icon-button
|
|
4348
|
+
*
|
|
4349
|
+
* @slot - The main content.
|
|
4350
|
+
* @slot header - The header.
|
|
4351
|
+
* @slot open_trigger - The label of the open trigger.
|
|
4352
|
+
*
|
|
4353
|
+
* @event cx-after-resize {{ side: 'left' | 'right', size: number }} - Emitted after the sidebar is resized.
|
|
4354
|
+
*
|
|
4355
|
+
* @csspart base - The component's base wrapper.
|
|
4356
|
+
* @csspart header - The container that wraps the header.
|
|
4357
|
+
* @csspart content - The container that wraps the main content.
|
|
4358
|
+
*/
|
|
4359
|
+
interface CxSidebarAttributes extends HTMLAttributes<CxSidebar> {
|
|
4360
|
+
|
|
4361
|
+
/**
|
|
4362
|
+
* Sets the side for the component.
|
|
4363
|
+
*/
|
|
4364
|
+
side?: 'right' | 'left';
|
|
4365
|
+
/**
|
|
4366
|
+
* Is the sidebar open?
|
|
4367
|
+
*/
|
|
4368
|
+
open?: boolean;
|
|
4369
|
+
/**
|
|
4370
|
+
* Make localization attributes reactive
|
|
4371
|
+
*/
|
|
4372
|
+
dir?: string;
|
|
4373
|
+
/**
|
|
4374
|
+
*
|
|
4375
|
+
*/
|
|
4376
|
+
lang?: string;
|
|
4377
|
+
}
|
|
4378
|
+
/**
|
|
4379
|
+
* @summary Multi-select allows the user to select multiple items from a list. The items can be moved between two columns. The user can move items between the columns by dragging and dropping them.
|
|
4380
|
+
* @element cx-multi-select
|
|
4381
|
+
*
|
|
4382
|
+
* @event {{ items: BoardItem[], name: string }} cx-multi-select-change - Emitted when the list items change.
|
|
4383
|
+
*/
|
|
4384
|
+
interface CxMultiSelectAttributes extends HTMLAttributes<CxMultiSelect> {
|
|
4385
|
+
|
|
4386
|
+
/**
|
|
4387
|
+
*
|
|
4388
|
+
*/
|
|
4389
|
+
firstColumnData?: CxMultiSelectColumnData;
|
|
4390
|
+
/**
|
|
4391
|
+
*
|
|
4392
|
+
*/
|
|
4393
|
+
secondColumnData?: CxMultiSelectColumnData;
|
|
4394
|
+
/**
|
|
4395
|
+
*
|
|
4396
|
+
*/
|
|
4397
|
+
configurable?: boolean;
|
|
4398
|
+
/**
|
|
4399
|
+
*
|
|
4400
|
+
*/
|
|
4401
|
+
ignoredTypes?: string[];
|
|
4402
|
+
/**
|
|
4403
|
+
*
|
|
4404
|
+
*/
|
|
4405
|
+
addLimit?: number;
|
|
4406
|
+
/**
|
|
4407
|
+
* Make localization attributes reactive
|
|
4408
|
+
*/
|
|
4409
|
+
dir?: string;
|
|
4410
|
+
/**
|
|
4411
|
+
*
|
|
4412
|
+
*/
|
|
4413
|
+
lang?: string;
|
|
4414
|
+
}
|
|
4415
|
+
/**
|
|
4416
|
+
* @class CxTemplateSwitcher
|
|
4417
|
+
* @extends CortexElement
|
|
4418
|
+
* @summary Custom web component for switching templates in the Cortex application. The component manages various settings and menu configurations for different views, sort orders, and other options.
|
|
4419
|
+
*
|
|
4420
|
+
* @property {TemplateSwitcherProps} data - The data object containing initial settings and other configurations.
|
|
4421
|
+
* @property {boolean | null} forcedSortOrder - Indicates if the sort order is forced.
|
|
4422
|
+
* @property {string | null} forcedSortOrderReason - The reason for forcing the sort order.
|
|
4423
|
+
* @property {MenuData} _menu - Internal state to store the menu data.
|
|
4424
|
+
* @property {Settings} _settings - Internal state to store the settings.
|
|
4425
|
+
* @property {boolean} _loading - Internal state to indicate if the component is loading.
|
|
4426
|
+
*
|
|
4427
|
+
* @method handleDataChange - Handles changes to the `data` property and updates settings accordingly.
|
|
4428
|
+
* @method handleSettingsChange - Handles changes to the `_settings` property and updates the menu.
|
|
4429
|
+
* @method handleAddCortexEvent - Adds a Cortex event using the provided event name and value.
|
|
4430
|
+
* @method handleItemSelect - Handles item selection events and updates settings or triggers events.
|
|
4431
|
+
* @method firstUpdated - Lifecycle method called after the component is first updated.
|
|
4432
|
+
* @method disconnectedCallback - Lifecycle method called when the component is disconnected from the DOM.
|
|
4433
|
+
* @method render - Renders the component's template.
|
|
4434
|
+
*
|
|
4435
|
+
* @event {{ item: MenuItem }} cx-select - Emitted when a menu item is selected.
|
|
4436
|
+
*/
|
|
4437
|
+
interface CxTemplateSwitcherAttributes extends HTMLAttributes<CxTemplateSwitcher> {
|
|
4438
|
+
|
|
4439
|
+
/**
|
|
4440
|
+
*
|
|
4441
|
+
*/
|
|
4442
|
+
data?: CxTemplateSwitcherTemplateSwitcherProps;
|
|
4443
|
+
/**
|
|
4444
|
+
*
|
|
4445
|
+
*/
|
|
4446
|
+
forcedSortOrder?: boolean;
|
|
4447
|
+
/**
|
|
4448
|
+
*
|
|
4449
|
+
*/
|
|
4450
|
+
forcedSortOrderReason?: string;
|
|
4451
|
+
/**
|
|
4452
|
+
*
|
|
4453
|
+
*/
|
|
4454
|
+
label?: string;
|
|
4455
|
+
/**
|
|
4456
|
+
* Make localization attributes reactive
|
|
4457
|
+
*/
|
|
4458
|
+
dir?: string;
|
|
4459
|
+
/**
|
|
4460
|
+
*
|
|
4461
|
+
*/
|
|
4462
|
+
lang?: string;
|
|
4463
|
+
}
|
|
4464
|
+
/**
|
|
4465
|
+
*
|
|
4466
|
+
*/
|
|
4467
|
+
interface CxTextToSpeechAttributes extends HTMLAttributes<CxTextToSpeech> {
|
|
4468
|
+
|
|
4469
|
+
/**
|
|
4470
|
+
*
|
|
4471
|
+
*/
|
|
4472
|
+
data?: CxTextToSpeechTextToSpeechData;
|
|
4473
|
+
/**
|
|
4474
|
+
*
|
|
4475
|
+
*/
|
|
4476
|
+
editable?: boolean;
|
|
4477
|
+
/**
|
|
4478
|
+
*
|
|
4479
|
+
*/
|
|
4480
|
+
autofocus?: boolean;
|
|
4481
|
+
/**
|
|
4482
|
+
*
|
|
4483
|
+
*/
|
|
4484
|
+
componentTitle?: string;
|
|
4485
|
+
/**
|
|
4486
|
+
*
|
|
4487
|
+
*/
|
|
4488
|
+
maxHeight?: string;
|
|
4489
|
+
/**
|
|
4490
|
+
*
|
|
4491
|
+
*/
|
|
4492
|
+
minHeight?: string;
|
|
4493
|
+
/**
|
|
4494
|
+
*
|
|
4495
|
+
*/
|
|
4496
|
+
mock?: boolean;
|
|
4497
|
+
/**
|
|
4498
|
+
* Make localization attributes reactive
|
|
4499
|
+
*/
|
|
4500
|
+
dir?: string;
|
|
4501
|
+
/**
|
|
4502
|
+
*
|
|
4503
|
+
*/
|
|
4504
|
+
lang?: string;
|
|
4505
|
+
}
|
|
4506
|
+
/**
|
|
4507
|
+
* @summary Downloader, but web component.
|
|
4508
|
+
*
|
|
4509
|
+
* @dependency cx-icon-button
|
|
4510
|
+
* @dependency cx-input
|
|
4511
|
+
* @dependency cx-icon
|
|
4512
|
+
* @dependency cx-button
|
|
4513
|
+
* @dependency cx-spinner
|
|
4514
|
+
* @dependency cx-tooltip
|
|
4515
|
+
* @dependency cx-menu
|
|
4516
|
+
* @dependency cx-menu-item
|
|
4517
|
+
* @dependency cx-switch
|
|
4518
|
+
* @dependency cx-range
|
|
4519
|
+
* @dependency cx-dropdown
|
|
4520
|
+
* @dependency cx-progress-bar
|
|
4521
|
+
* @dependency cx-badge
|
|
4522
|
+
* @dependency cx-dialog
|
|
4523
|
+
* @dependency cx-divider
|
|
4524
|
+
* @dependency cx-checkbox
|
|
4525
|
+
* @dependency cx-pagination
|
|
4526
|
+
* @dependency cx-typography
|
|
4527
|
+
*/
|
|
4528
|
+
interface CxDownloaderAttributes extends HTMLAttributes<CxDownloader> {
|
|
4529
|
+
|
|
4530
|
+
/**
|
|
4531
|
+
*
|
|
4532
|
+
*/
|
|
4533
|
+
ctx?: CxDownloaderExecutionContext;
|
|
4534
|
+
/**
|
|
4535
|
+
*
|
|
4536
|
+
*/
|
|
4537
|
+
userId?: string;
|
|
4538
|
+
/**
|
|
4539
|
+
*
|
|
4540
|
+
*/
|
|
4541
|
+
workerURL?: string;
|
|
4542
|
+
/**
|
|
4543
|
+
* Make localization attributes reactive
|
|
4544
|
+
*/
|
|
4545
|
+
dir?: string;
|
|
4546
|
+
/**
|
|
4547
|
+
*
|
|
4548
|
+
*/
|
|
4549
|
+
lang?: string;
|
|
4550
|
+
}
|
|
4551
|
+
/**
|
|
4552
|
+
*
|
|
4553
|
+
*/
|
|
4554
|
+
interface CxCommentAttributes extends HTMLAttributes<CxComment> {
|
|
4555
|
+
|
|
4556
|
+
/**
|
|
4557
|
+
*
|
|
4558
|
+
*/
|
|
4559
|
+
content?: string;
|
|
4560
|
+
/**
|
|
4561
|
+
*
|
|
4562
|
+
*/
|
|
4563
|
+
editable?: boolean;
|
|
4564
|
+
/**
|
|
4565
|
+
*
|
|
4566
|
+
*/
|
|
4567
|
+
autofocus?: boolean;
|
|
4568
|
+
/**
|
|
4569
|
+
*
|
|
4570
|
+
*/
|
|
4571
|
+
canUpload?: boolean;
|
|
4572
|
+
/**
|
|
4573
|
+
*
|
|
4574
|
+
*/
|
|
4575
|
+
recording?: boolean;
|
|
4576
|
+
/**
|
|
4577
|
+
*
|
|
4578
|
+
*/
|
|
4579
|
+
queryName?: string;
|
|
4580
|
+
/**
|
|
4581
|
+
*
|
|
4582
|
+
*/
|
|
4583
|
+
filterName?: string;
|
|
4584
|
+
/**
|
|
4585
|
+
*
|
|
4586
|
+
*/
|
|
4587
|
+
autocompletionViewstate?: string;
|
|
4588
|
+
/**
|
|
4589
|
+
*
|
|
4590
|
+
*/
|
|
4591
|
+
maxCount?: number;
|
|
4592
|
+
/**
|
|
4593
|
+
*
|
|
4594
|
+
*/
|
|
4595
|
+
queryDelay?: number;
|
|
4596
|
+
/**
|
|
4597
|
+
*
|
|
4598
|
+
*/
|
|
4599
|
+
minQueryLength?: number;
|
|
4600
|
+
/**
|
|
4601
|
+
* Make localization attributes reactive
|
|
4602
|
+
*/
|
|
4603
|
+
dir?: string;
|
|
4604
|
+
/**
|
|
4605
|
+
*
|
|
4606
|
+
*/
|
|
4607
|
+
lang?: string;
|
|
4608
|
+
}
|
|
4609
|
+
export type CxIconProps = DetailedHTMLProps<CxIconAttributes, CxIcon> & {class?: string};export type CxIconButtonProps = DetailedHTMLProps<CxIconButtonAttributes, CxIconButton> & {class?: string};export type CxAlertProps = DetailedHTMLProps<CxAlertAttributes, CxAlert> & {class?: string};export type CxAnimatedImageProps = DetailedHTMLProps<CxAnimatedImageAttributes, CxAnimatedImage> & {class?: string};export type CxAnimationProps = DetailedHTMLProps<CxAnimationAttributes, CxAnimation> & {class?: string};export type CxAvatarProps = DetailedHTMLProps<CxAvatarAttributes, CxAvatar> & {class?: string};export type CxBadgeProps = DetailedHTMLProps<CxBadgeAttributes, CxBadge> & {class?: string};export type CxBreadcrumbItemProps = DetailedHTMLProps<CxBreadcrumbItemAttributes, CxBreadcrumbItem> & {class?: string};export type CxBreadcrumbProps = DetailedHTMLProps<CxBreadcrumbAttributes, CxBreadcrumb> & {class?: string};export type CxSpinnerProps = DetailedHTMLProps<CxSpinnerAttributes, CxSpinner> & {class?: string};export type CxButtonProps = DetailedHTMLProps<CxButtonAttributes, CxButton> & {class?: string};export type CxButtonGroupProps = DetailedHTMLProps<CxButtonGroupAttributes, CxButtonGroup> & {class?: string};export type CxCardProps = DetailedHTMLProps<CxCardAttributes, CxCard> & {class?: string};export type CxCarouselItemProps = DetailedHTMLProps<CxCarouselItemAttributes, CxCarouselItem> & {class?: string};export type CxCarouselProps = DetailedHTMLProps<CxCarouselAttributes, CxCarousel> & {class?: string};export type CxPopupProps = DetailedHTMLProps<CxPopupAttributes, CxPopup> & {class?: string};export type CxTooltipProps = DetailedHTMLProps<CxTooltipAttributes, CxTooltip> & {class?: string};export type CxMarkdownProps = DetailedHTMLProps<CxMarkdownAttributes, CxMarkdown> & {class?: string};export type CxTypographyProps = DetailedHTMLProps<CxTypographyAttributes, CxTypography> & {class?: string};export type CxCheckboxProps = DetailedHTMLProps<CxCheckboxAttributes, CxCheckbox> & {class?: string};export type CxMenuItemProps = DetailedHTMLProps<CxMenuItemAttributes, CxMenuItem> & {class?: string};export type CxMenuProps = DetailedHTMLProps<CxMenuAttributes, CxMenu> & {class?: string};export type CxInputProps = DetailedHTMLProps<CxInputAttributes, CxInput> & {class?: string};export type CxDropdownProps = DetailedHTMLProps<CxDropdownAttributes, CxDropdown> & {class?: string};export type CxDividerProps = DetailedHTMLProps<CxDividerAttributes, CxDivider> & {class?: string};export type CxVisuallyHiddenProps = DetailedHTMLProps<CxVisuallyHiddenAttributes, CxVisuallyHidden> & {class?: string};export type CxColorPickerProps = DetailedHTMLProps<CxColorPickerAttributes, CxColorPicker> & {class?: string};export type CxCopyButtonProps = DetailedHTMLProps<CxCopyButtonAttributes, CxCopyButton> & {class?: string};export type CxDetailsProps = DetailedHTMLProps<CxDetailsAttributes, CxDetails> & {class?: string};export type CxDialogProps = DetailedHTMLProps<CxDialogAttributes, CxDialog> & {class?: string};export type CxDrawerProps = DetailedHTMLProps<CxDrawerAttributes, CxDrawer> & {class?: string};export type CxElementClampProps = DetailedHTMLProps<CxElementClampAttributes, CxElementClamp> & {class?: string};export type CxFormatBytesProps = DetailedHTMLProps<CxFormatBytesAttributes, CxFormatBytes> & {class?: string};export type CxFormatDateProps = DetailedHTMLProps<CxFormatDateAttributes, CxFormatDate> & {class?: string};export type CxFormatNumberProps = DetailedHTMLProps<CxFormatNumberAttributes, CxFormatNumber> & {class?: string};export type CxHubConnectionProps = DetailedHTMLProps<CxHubConnectionAttributes, CxHubConnection> & {class?: string};export type CxImageComparerProps = DetailedHTMLProps<CxImageComparerAttributes, CxImageComparer> & {class?: string};export type CxIncludeProps = DetailedHTMLProps<CxIncludeAttributes, CxInclude> & {class?: string};export type CxInputGroupProps = DetailedHTMLProps<CxInputGroupAttributes, CxInputGroup> & {class?: string};export type CxResizeObserverProps = DetailedHTMLProps<CxResizeObserverAttributes, CxResizeObserver> & {class?: string};export type CxLineClampProps = DetailedHTMLProps<CxLineClampAttributes, CxLineClamp> & {class?: string};export type CxMenuLabelProps = DetailedHTMLProps<CxMenuLabelAttributes, CxMenuLabel> & {class?: string};export type CxMenuSectionProps = DetailedHTMLProps<CxMenuSectionAttributes, CxMenuSection> & {class?: string};export type CxMutationObserverProps = DetailedHTMLProps<CxMutationObserverAttributes, CxMutationObserver> & {class?: string};export type CxOptionProps = DetailedHTMLProps<CxOptionAttributes, CxOption> & {class?: string};export type CxTagProps = DetailedHTMLProps<CxTagAttributes, CxTag> & {class?: string};export type CxSelectProps = DetailedHTMLProps<CxSelectAttributes, CxSelect> & {class?: string};export type CxTreeItemProps = DetailedHTMLProps<CxTreeItemAttributes, CxTreeItem> & {class?: string};export type CxPaginationProps = DetailedHTMLProps<CxPaginationAttributes, CxPagination> & {class?: string};export type CxProgressBarProps = DetailedHTMLProps<CxProgressBarAttributes, CxProgressBar> & {class?: string};export type CxProgressRingProps = DetailedHTMLProps<CxProgressRingAttributes, CxProgressRing> & {class?: string};export type CxQrCodeProps = DetailedHTMLProps<CxQrCodeAttributes, CxQrCode> & {class?: string};export type CxRadioProps = DetailedHTMLProps<CxRadioAttributes, CxRadio> & {class?: string};export type CxRadioButtonProps = DetailedHTMLProps<CxRadioButtonAttributes, CxRadioButton> & {class?: string};export type CxRadioCardProps = DetailedHTMLProps<CxRadioCardAttributes, CxRadioCard> & {class?: string};export type CxRadioGroupProps = DetailedHTMLProps<CxRadioGroupAttributes, CxRadioGroup> & {class?: string};export type CxRangeProps = DetailedHTMLProps<CxRangeAttributes, CxRange> & {class?: string};export type CxRatingProps = DetailedHTMLProps<CxRatingAttributes, CxRating> & {class?: string};export type CxRelativeTimeProps = DetailedHTMLProps<CxRelativeTimeAttributes, CxRelativeTime> & {class?: string};export type CxSkeletonProps = DetailedHTMLProps<CxSkeletonAttributes, CxSkeleton> & {class?: string};export type CxSpaceProps = DetailedHTMLProps<CxSpaceAttributes, CxSpace> & {class?: string};export type CxSplitPanelProps = DetailedHTMLProps<CxSplitPanelAttributes, CxSplitPanel> & {class?: string};export type CxStepProps = DetailedHTMLProps<CxStepAttributes, CxStep> & {class?: string};export type CxStepperProps = DetailedHTMLProps<CxStepperAttributes, CxStepper> & {class?: string};export type CxSwitchProps = DetailedHTMLProps<CxSwitchAttributes, CxSwitch> & {class?: string};export type CxTabProps = DetailedHTMLProps<CxTabAttributes, CxTab> & {class?: string};export type CxTabPanelProps = DetailedHTMLProps<CxTabPanelAttributes, CxTabPanel> & {class?: string};export type CxTabGroupProps = DetailedHTMLProps<CxTabGroupAttributes, CxTabGroup> & {class?: string};export type CxTextareaProps = DetailedHTMLProps<CxTextareaAttributes, CxTextarea> & {class?: string};export type CxTreeProps = DetailedHTMLProps<CxTreeAttributes, CxTree> & {class?: string};export type CxGridProps = DetailedHTMLProps<CxGridAttributes, CxGrid> & {class?: string};export type CxGridItemProps = DetailedHTMLProps<CxGridItemAttributes, CxGridItem> & {class?: string};export type CxChatbotProps = DetailedHTMLProps<CxChatbotAttributes, CxChatbot> & {class?: string};export type CxConfirmPopoverProps = DetailedHTMLProps<CxConfirmPopoverAttributes, CxConfirmPopover> & {class?: string};export type CxFileOnDemandProps = DetailedHTMLProps<CxFileOnDemandAttributes, CxFileOnDemand> & {class?: string};export type CxSidebarLayoutProps = DetailedHTMLProps<CxSidebarLayoutAttributes, CxSidebarLayout> & {class?: string};export type CxGraphViewProps = DetailedHTMLProps<CxGraphViewAttributes, CxGraphView> & {class?: string};export type CxStepperWizardProps = DetailedHTMLProps<CxStepperWizardAttributes, CxStepperWizard> & {class?: string};export type CxClusterManagementProps = DetailedHTMLProps<CxClusterManagementAttributes, CxClusterManagement> & {class?: string};export type CxStorybookProps = DetailedHTMLProps<CxStorybookAttributes, CxStorybook> & {class?: string};export type CxSidebarProps = DetailedHTMLProps<CxSidebarAttributes, CxSidebar> & {class?: string};export type CxMultiSelectProps = DetailedHTMLProps<CxMultiSelectAttributes, CxMultiSelect> & {class?: string};export type CxTemplateSwitcherProps = DetailedHTMLProps<CxTemplateSwitcherAttributes, CxTemplateSwitcher> & {class?: string};export type CxTextToSpeechProps = DetailedHTMLProps<CxTextToSpeechAttributes, CxTextToSpeech> & {class?: string};export type CxDownloaderProps = DetailedHTMLProps<CxDownloaderAttributes, CxDownloader> & {class?: string};export type CxCommentProps = DetailedHTMLProps<CxCommentAttributes, CxComment> & {class?: string};
|
|
4610
|
+
declare module "react" {
|
|
4611
|
+
namespace JSX {
|
|
4612
|
+
interface IntrinsicElements {
|
|
4613
|
+
['cx-icon']: CxIconProps;['cx-icon-button']: CxIconButtonProps;['cx-alert']: CxAlertProps;['cx-animated-image']: CxAnimatedImageProps;['cx-animation']: CxAnimationProps;['cx-avatar']: CxAvatarProps;['cx-badge']: CxBadgeProps;['cx-breadcrumb-item']: CxBreadcrumbItemProps;['cx-breadcrumb']: CxBreadcrumbProps;['cx-spinner']: CxSpinnerProps;['cx-button']: CxButtonProps;['cx-button-group']: CxButtonGroupProps;['cx-card']: CxCardProps;['cx-carousel-item']: CxCarouselItemProps;['cx-carousel']: CxCarouselProps;['cx-popup']: CxPopupProps;['cx-tooltip']: CxTooltipProps;['cx-markdown']: CxMarkdownProps;['cx-typography']: CxTypographyProps;['cx-checkbox']: CxCheckboxProps;['cx-menu-item']: CxMenuItemProps;['cx-menu']: CxMenuProps;['cx-input']: CxInputProps;['cx-dropdown']: CxDropdownProps;['cx-divider']: CxDividerProps;['cx-visually-hidden']: CxVisuallyHiddenProps;['cx-color-picker']: CxColorPickerProps;['cx-copy-button']: CxCopyButtonProps;['cx-details']: CxDetailsProps;['cx-dialog']: CxDialogProps;['cx-drawer']: CxDrawerProps;['cx-element-clamp']: CxElementClampProps;['cx-format-bytes']: CxFormatBytesProps;['cx-format-date']: CxFormatDateProps;['cx-format-number']: CxFormatNumberProps;['cx-hub-connection']: CxHubConnectionProps;['cx-image-comparer']: CxImageComparerProps;['cx-include']: CxIncludeProps;['cx-input-group']: CxInputGroupProps;['cx-resize-observer']: CxResizeObserverProps;['cx-line-clamp']: CxLineClampProps;['cx-menu-label']: CxMenuLabelProps;['cx-menu-section']: CxMenuSectionProps;['cx-mutation-observer']: CxMutationObserverProps;['cx-option']: CxOptionProps;['cx-tag']: CxTagProps;['cx-select']: CxSelectProps;['cx-tree-item']: CxTreeItemProps;['cx-pagination']: CxPaginationProps;['cx-progress-bar']: CxProgressBarProps;['cx-progress-ring']: CxProgressRingProps;['cx-qr-code']: CxQrCodeProps;['cx-radio']: CxRadioProps;['cx-radio-button']: CxRadioButtonProps;['cx-radio-card']: CxRadioCardProps;['cx-radio-group']: CxRadioGroupProps;['cx-range']: CxRangeProps;['cx-rating']: CxRatingProps;['cx-relative-time']: CxRelativeTimeProps;['cx-skeleton']: CxSkeletonProps;['cx-space']: CxSpaceProps;['cx-split-panel']: CxSplitPanelProps;['cx-step']: CxStepProps;['cx-stepper']: CxStepperProps;['cx-switch']: CxSwitchProps;['cx-tab']: CxTabProps;['cx-tab-panel']: CxTabPanelProps;['cx-tab-group']: CxTabGroupProps;['cx-textarea']: CxTextareaProps;['cx-tree']: CxTreeProps;['cx-grid']: CxGridProps;['cx-grid-item']: CxGridItemProps;['cx-chatbot']: CxChatbotProps;['cx-confirm-popover']: CxConfirmPopoverProps;['cx-file-on-demand']: CxFileOnDemandProps;['cx-sidebar-layout']: CxSidebarLayoutProps;['cx-graph-view']: CxGraphViewProps;['cx-stepper-wizard']: CxStepperWizardProps;['cx-cluster-management']: CxClusterManagementProps;['cx-storybook']: CxStorybookProps;['cx-sidebar']: CxSidebarProps;['cx-multi-select']: CxMultiSelectProps;['cx-template-switcher']: CxTemplateSwitcherProps;['cx-text-to-speech']: CxTextToSpeechProps;['cx-downloader']: CxDownloaderProps;['cx-comment']: CxCommentProps;
|
|
4614
|
+
}
|
|
4615
|
+
}
|
|
4616
|
+
}
|
|
4617
|
+
|