@carbon/ibm-products
Version:
Carbon for IBM Products
1,387 lines (1,385 loc) • 33.6 kB
YAML
version: 1
projectId: 495342db-5046-4ecf-85ea-9ffceb6f8cdf
endpoint: https://www-api.ibm.com/ibm-telemetry/v1/metrics
collect:
jsx:
elements:
allowedAttributeNames:
- accordionItemProps
- accordionProps
- action
- actionIcons
- actions
- actionsPlacement
- actionsSlot
- activeCellCoordinates
- activeHref
- addConditionSubGroupHandler
- aiLabel
- align
- allPageRowsLabel
- allRowsLabel
- allTagsModalAriaLabel
- allTagsModalSearchLabel
- allTagsModalSearchPlaceholderText
- allTagsModalSearchThreshold
- allTagsModalTarget
- allTagsModalTitle
- alt
- apiKey
- appliedModifiers
- aria
- ariaLabel
- ariaToolbarLabel
- assistiveText
- assistiveTextDisabledInstructionsLabel
- assistiveTextInstructionsLabel
- autoAlign
- backButtonText
- backgroundColor
- batchActionMenuButtonLabel
- batchActions
- body
- border
- breadcrumbOverflowTooltipAlign
- breadcrumbs
- button
- buttonProps
- buttonSize
- cancelButtonText
- caret
- cellSize
- children
- className
- clearFiltersText
- clickZone
- closeButtonLabel
- closeIconDescription
- closePopover
- collapseButtonLabel
- collapseText
- collapsible
- column
- columnInputPlaceholder
- columns
- condition
- conditionState
- config
- containingElementRef
- count
- currentMatcher
- currentStep
- CustomizeColumnsButton
- customizeColumnsProps
- CustomizeColumnsTearsheet
- customizeTearsheetHeadingLabel
- data
- DatagridActions
- DatagridBatchActions
- DatagridPagination
- datagridState
- decorator
- defaultColumn
- defaultEmptyRowCount
- description
- disableColumnSwapping
- disabled
- disabledCell
- disableSubmit
- displayMetalPanel
- downloadLinkLabel
- draggableClass
- element
- emptyStateAction
- emptyStateDescription
- emptyStateLink
- emptyStateSize
- emptyStateTitle
- emptyStateType
- enableSpacerColumn
- error
- errorCodeLabel
- errorMessage
- expandButtonLabel
- expandedContentHeight
- ExpandedRowContentComponent
- expandedRowIds
- expandText
- fetchMoreData
- fieldsetLegendId
- fieldsetLegendText
- filterByLabel
- filterProps
- filters
- filterString
- findColumnPlaceholderLabel
- firstFocusElement
- footerActionIcon
- formDescription
- formTitle
- fullHeightDatagrid
- getActionsState
- getAsyncSubRows
- getConditionState
- getFilterFlyoutProps
- getOptions
- globalFilters
- globalFiltersIconDescription
- globalFiltersLabel
- globalFiltersPlaceholderText
- globalFiltersPrimaryButtonText
- globalFiltersSecondaryButtonText
- globalSearchLabel
- globalSearchPlaceholder
- globalSortBy
- grid
- gridDescription
- gridGap
- gridRef
- gridTitle
- group
- handleResize
- hasActions
- hasCloseIcon
- hasCustomRowHeader
- hasError
- hasFieldset
- headerActions
- headerContent
- headerGroups
- HeaderRow
- headers
- headingAs
- headRef
- hideCloseButton
- hideConditionPreviewHandler
- hideConditionSubGroupPreviewHandler
- hideIcon
- hideSearch
- hideSelectAll
- href
- icon
- iconDescription
- id
- illustration
- illustrationDescription
- illustrationPosition
- illustrationTheme
- image
- imageDescription
- includeStep
- includeUnderlay
- index
- influencer
- influencerPosition
- influencerTitle
- influencerWidth
- initialState
- initialStep
- innerListRef
- inputConfig
- inputLabel
- inputPlaceholder
- instance
- instructionsLabel
- introStep
- invalid
- invalidText
- isFetching
- isFlush
- isOpen
- isTableSortable
- item
- itemCount
- items
- itemsLabel
- key
- kind
- label
- labelText
- launcherButtonRef
- legendText
- lines
- link
- links
- listRef
- loading
- loadMoreThreshold
- maxVisible
- measurementOffset
- media
- mediaPosition
- menuOptionsClass
- metadata
- metaIconDescription
- metaPanelTitle
- modifiers
- multi
- multiline
- multiSelection
- navIconDescription
- navigation
- navLinkLabels
- nextButtonText
- nonEditCell
- noResultsDescription
- noResultsTitle
- noSelectionDescription
- noSelectionTitle
- noTearsheet
- noTrailingSlash
- onActiveCellChange
- onAddItem
- onAllRowSelect
- onApply
- onBlur
- onCancel
- onChange
- onClick
- onClickLabel
- onClickValue
- onClose
- onCloseButtonText
- onColResizeEnd
- onContextMenu
- onContextMenuLabel
- onContextMenuValue
- onDataUpdate
- onFocus
- onKeyDown
- onMount
- onMouseEnter
- onMouseLeave
- onNext
- onOverflowClick
- onOverflowTagChange
- onPrevious
- onPrimaryButtonClick
- onRemove
- onRemoveItem
- onRequestClose
- onRequestSubmit
- onRowClick
- onRowExpand
- onScroll
- onSearch
- onSecondaryButtonClick
- onSelectAllRows
- onSelectColumn
- onSelectionAreaChange
- onShowAllClick
- onSort
- onSubmit
- onSubmitButtonText
- onToggle
- onVirtualScroll
- onWidthChange
- open
- originalColumnDefinitions
- overflowActions
- overflowAlign
- overflowAriaLabel
- overflowAutoAlign
- overflowClassName
- overflowTags
- overflowTooltipAlign
- overflowType
- pageActions
- parentId
- path
- pictogram
- placeholder
- placement
- popoverOpen
- popOverSearchThreshold
- portalTarget
- preventCloseOnClickOutside
- previousButtonLabel
- primaryActionLabel
- primaryButtonDisabled
- primaryButtonHref
- primaryButtonIcon
- primaryButtonKind
- primaryButtonPlacement
- primaryButtonText
- productive
- radio
- reactTableFiltersState
- readOnly
- readOnlyTable
- renderIcon
- renderItem
- renderMedia
- renderRowHeader
- renderRowHeaderDirection
- resetToDefaultLabel
- resizerAriaLabel
- rightAlign
- row
- rowActions
- rows
- rowSize
- score
- scoreThresholds
- scrollBarSize
- scroller
- searchPlaceholder
- searchProps
- searchResultsTitle
- secondaryActionLabel
- secondaryButtonDisabled
- secondaryButtonHref
- secondaryButtonIcon
- secondaryButtonKind
- secondaryButtonPlacement
- secondaryButtonText
- secondaryLabel
- selectAllAriaLabel
- selectAllLabel
- selectAllToggle
- selected
- selectedHeaderReorderActive
- selectedItems
- selectedOption
- selectionAreas
- selectorPageContent
- selectorPrimaryFocus
- selectorsFloatingMenus
- sequence
- setActiveCellCoordinates
- setAllFilters
- setColumnsObject
- setCurrentMatcher
- setDisplayMetaPanel
- setGlobalFilter
- setHeaderCellHoldActive
- setIsTearsheetOpen
- setLabelTitle
- setMouseOverRowIndex
- setMultiSelection
- setPopoverOpen
- setSelectedHeaderReorderActive
- setSelectionAreaData
- setSelectionAreas
- showAllTagsLabel
- showCloseButton
- showConditionPreviewHandler
- showConditionSubGroupPreviewHandler
- showToolTip
- sideNavAriaLabel
- size
- slideIn
- slug
- small
- sortByLabel
- startConditionLabel
- state
- statementConfigCustom
- status
- style
- submitButtonText
- subtitle
- tabIndex
- tableHeight
- tableId
- tagline
- tagProps
- tags
- theme
- title
- titleSize
- toolbarBatchActions
- toolbarBatchActionsDisplayMin
- tooltipAlign
- tooltipAlignment
- tooltipText
- totalVisibleColumns
- translateWithId
- translateWithIdBatchActions
- triggerButtonRef
- truncate
- truncateValue
- type
- updateMethod
- useDenseHeader
- useDragOverlay
- value
- valueTitle
- variableRowHeight
- variant
- verticalAlign
- verticalPosition
- viewAllLabel
- viewLessLabel
- virtualHeight
- visibleColumns
- withExpandedRows
- withInlineEdit
- withLeftGutter
- withMouseHover
- withNestedRows
- withStickyColumn
- withVirtualScroll
- wrapperStyle
- additionalInfo
- content
- copyrightText
- logo
- modalAriaLabel
- version
- overflowItems
- overflowMenuRef
- searchText
- setSearchText
- disableStacking
- onItemSelect
- breadcrumbItemProps
- breadcrumbProps
- defaultModifiers
- globalFilterOpts
- linkProps
- normalizedItems
- onBreadcrumbClick
- subHeaderActions
- useNormalizedItems
- allIndeterminate
- allSelected
- header
- onNavigate
- onSelectAll
- searchLabel
- selectAllCheckboxProps
- setPath
- showSelectAll
- layout
- appliedFilters
- filterOpts
- filtersLabel
- handleFilter
- handleSearch
- hasFiltersApplied
- searchTerm
- closeIconButtonProps
- filteredItems
- focus
- parentSelected
- setAppliedModifiers
- setFocus
- setParentSelected
- setSingleSelection
- setSize
- singleSelection
- meta
- checkboxProps
- hasChildren
- hasItemPanel
- indeterminate
- itemId
- itemPanelIconButtonProps
- itemPanelIconDescription
- itemPanelOpen
- onItemPanelClick
- radioButtonProps
- rowContent
- editIconButtonProps
- editIconDescription
- emptyState
- onEdit
- showCount
- showEditIcon
- removeButtonLabel
- removeIconButtonProps
- renderAccordionBody
- renderAccordionTitle
- useAccordion
- setSortAttribute
- setSortDirection
- sortBy
- fileName
- fileType
- linkText
- apiKeyLabel
- apiKeyName
- closeButtonText
- copyButtonText
- copyErrorText
- copyIconDescription
- customSteps
- downloadBodyText
- downloadFileName
- downloadFileType
- downloadLinkText
- editButtonText
- editing
- editSuccess
- editSuccessMessage
- editSuccessTitle
- errorText
- generateButtonText
- generateSuccessBody
- generateSuccessMessage
- generateSuccessTitle
- generateTitle
- hasAPIKeyVisibilityToggle
- hasDownloadLink
- helperText
- hideAPIKeyLabel
- loadingText
- modalLabel
- nameHelperText
- nameLabel
- namePlaceholder
- nameRequired
- nextStepButtonText
- onCopy
- onRequestEdit
- onRequestGenerate
- previousStepButtonText
- showAPIKeyLabel
- forceShowTotal
- fractionDigits
- iconButton
- locale
- percentage
- tooltipDescription
- total
- trending
- menuAriaLabel
- buttons
- buttonSetOverflowLabel
- iconTooltipLabel
- isTearsheetOpen
- componentName
- clickable
- getStarted
- hasButton
- inClickableCard
- noActionIcons
- disableArrowScroll
- disableResetOnResize
- fadedEdgeColor
- isScrollMode
- onChangeIsScrollable
- chartLabel
- chartValue
- checklistAriaLabel
- checklistToggleAriaLabel
- enableToggle
- onClickViewAll
- taskLists
- toggleLabel
- toggleLabelAlign
- dropShadow
- floating
- highContrast
- isOpenByDefault
- overlayClassName
- overlayKind
- overlayRef
- position
- positionTune
- target
- aria-label
- dragAriaLabel
- dragIconDescription
- a11yKeyboardHandler
- onDrag
- fixedIsVisible
- isVisible
- onBack
- onClickNavItem
- disabledInstructionsLabel
- getVisibleColumnsCount
- setColumnStatus
- overflowMenu
- addConditionHandler
- conditionIndex
- conjunction
- isLastCondition
- isStatement
- onConnectorOperatorChange
- onStatementChange
- buttonLabel
- enableSubGroup
- hideLabel
- isInvalid
- wrapperClassName
- wrapperProps
- popOverClassName
- renderChildren
- parentRef
- actionState
- conditionBuilderRef
- rootState
- setActionState
- setRootState
- operator
- colorIndex
- previewType
- breadcrumbsOverflowAriaLabel
- maxVisibleBreadcrumbs
- modalDangerButtonText
- modalDescription
- modalSecondaryButtonText
- modalTitle
- onClickInfluencerStep
- secondaryTitle
- onClickStep
- stepData
- experimentalSecondarySubmitText
- experimentalSecondarySubmit
- columnDefinitions
- onSaveColumnPrefs
- primaryButtonTextLabel
- secondaryButtonTextLabel
- onColDrag
- spreadsheetAriaLabel
- activeCellRef
- clickAndHoldActive
- getTableBodyProps
- prepareRow
- selectionAreaData
- setActiveCellInsideSelectionArea
- setClickAndHoldActive
- setColumnOrder
- setContainerHasFocus
- setCurrentColumns
- totalColumnsWidth
- headerCellHoldActive
- updateActiveCellCoordinates
- magnitude
- delimiter
- classList
- elementId
- isSticky
- moveElement
- setAriaRegionText
- cancelLabel
- editAlwaysVisible
- editLabel
- inheritTypography
- invalidLabel
- onSave
- readOnlyLabel
- readOnlyToggleTipText
- saveLabel
- toggleTipAlignment
- onFormChange
- editChildren
- editMode
- previewChildren
- v2
- borderColor
- boxedBorder
- onPrimaryClick
- onSecondaryClick
- primaryButtonLabel
- primaryKind
- secondaryButtonLabel
- secondaryIcon
- secondaryKind
- usesExampleHook
- filename
- hidePasswordLabel
- inputType
- invalidInputText
- loadingMessage
- preformattedExtensions
- preformattedExtensionsLabel
- showPasswordLabel
- successful
- successMessage
- validExtensions
- defaultPortalTargetBody
- enableDatagridUseCustomizeColumns
- enableDatagridUseEditableCell
- enableDatagridUseInlineEdit
- enableSidepanelResizer
- enableTestFlagA
- enableTestFlagB
- flags
- flyoutIconDescription
- onFlyoutClose
- onFlyoutOpen
- autoHideFilters
- filterPanelMinHeight
- filterSections
- onPanelClose
- onPanelOpen
- searchLabelText
- showFilterSearch
- truncatedListProps
- overflowMenuProps
- clearButtonInline
- clearFilters
- renderLabel
- nextIconDescription
- previousIconDescription
- accept
- defaultErrorBody
- defaultErrorHeader
- fetchErrorBody
- fetchErrorHeader
- fileDropHeader
- fileDropLabel
- fileUploadLabel
- hideInputLabel
- inputButtonIcon
- inputButtonText
- inputId
- invalidFileTypeErrorBody
- invalidFileTypeErrorHeader
- invalidIconDescription
- maxFileSize
- maxFileSizeErrorBody
- maxFileSizeErrorHeader
- influencerPanelAriaLabel
- influencerPanelOpen
- influencerPanelTriggerRef
- columnConfig
- isActiveCell
- labelIcon
- cell
- narrow
- tertiaryButtonLabel
- isFullScreen
- contentRenderer
- actionButtonRenderer
- nextButtonLabel
- onAction
- skipButtonLabel
- startButtonLabel
- headerSubTitle
- headerTitle
- hideProgressIndicator
- stepTitle
- disableActionButton
- attributes
- dragOverlay
- isDragging
- listeners
- setNodeRef
- transform
- transition
- heading
- current
- isExpandedOnPageLoad
- navigationItemTitle
- onItemClick
- onListClick
- definition
- dateTimeLocale
- dateTimeStyle
- daysAgoText
- dismissAllLabel
- dismissSingleNotificationIconDescription
- doNotDisturbDefaultToggled
- doNotDisturbLabel
- emptyStateLabel
- hourAgoText
- hoursAgoText
- minuteAgoText
- minutesAgoText
- monthAgoText
- monthsAgoText
- nowText
- onClickOutside
- onDismissAllNotifications
- onDismissSingleNotification
- onDoNotDisturbChange
- onSettingsClick
- onViewAllClick
- previousLabel
- readLessLabel
- readMoreLabel
- secondsAgoText
- settingsIconDescription
- todayLabel
- yearAgoText
- yearsAgoText
- yesterdayAtText
- yesterdayLabel
- enabled
- locked
- lockedText
- summary
- titleId
- warn
- warnText
- applyFilters
- components
- filtersState
- setFiltersState
- actionBarItems
- actionBarMenuOptionsClass
- actionBarOverflowAriaLabel
- breadcrumbLabel
- breadcrumbOverflowAriaLabel
- collapseHeader
- collapseHeaderIconDescription
- collapseTitle
- disableBreadcrumbScroll
- enableBreadcrumbScroll
- expandHeaderIconDescription
- fullWidthGrid
- hasBackgroundAlways
- hasCollapseHeaderToggle
- narrowGrid
- onContentActionsClipped
- onContentFullyCollapsed
- onTitleClipped
- pageActionsMenuOptionsClass
- pageActionsOverflowLabel
- withoutBackground
- actionsAriaLabel
- contentActions
- contentActionsFlush
- pageActionsFlush
- renderOverflowBreadcrumb
- buttonKind
- overflowMenuLabel
- contextualActions
- titleAs
- menuButtonLabel
- subtitleAs
- objectFit
- disableStickyTabBar
- renderOverflowTag
- renderPopoverContent
- blockClass
- hasBreadcrumbRow
- inputInvalidText
- inputLabelText
- inputPlaceholderText
- primaryDangerDescription
- resourceName
- textConfirmation
- datagridName
- light
- rowSizeLabels
- rowSizes
- defaultIconDescription
- defaultText
- failIconDescription
- failText
- inProgressIconDescription
- inProgressText
- onRequestCancel
- onRequestSave
- successIconDescription
- successText
- color
- getScrollElementRef
- hideStartGradient
- scrollElementClassName
- clearButtonLabelText
- hideScopesLabel
- placeholderText
- scopes
- scopesTypeLabel
- scopeToString
- selectedScopes
- sortItems
- submitLabel
- titleText
- getToggleAllPageRowsSelectedProps
- getToggleAllRowsSelectedProps
- isAllRowsSelected
- actionToolbarButtons
- animateTitle
- closeIconTooltipAlignment
- condensedActions
- includeOverlay
- navigationBackIconDescription
- onNavigationBack
- onUnmount
- searchResultsLabel
- adjustScale
- Container
- restrictToParent
- sortableProps
- strategy
- withGrid
- stackStepSize
- onRetry
- retryLabel
- showRetry
- tooltipDirection
- width
- summaryPanelAriaLabel
- summaryPanelOpen
- summaryPanelTriggerRef
- tagComponent
- containerClassName
- disablePortal
- keepMounted
- summaryContentWidth
- verticalGap
- disableHeaderCollapse
- overflowItemLabel
- menuButtonProps
- titleEnd
- titleStart
- _autoEnablePresence
- _presenceId
- progressIndicator
- setOpen
- vertical
- as
- buttonClassName
- collapsedItemsLimit
- expandedItemsLimit
- viewMoreLabel
- collapseLabel
- expandLabel
- activeId
- name
- initials
- documentationLinks
- documentationLinksIconDescription
- isInitiallyOpen
- webTerminalAriaLabel
- key
- ref
allowedAttributeStringValues:
- bottom
- top
- bottom
- bottom-left
- bottom-right
- center
- end
- left
- left-bottom
- left-top
- right
- right-bottom
- right-top
- start
- top
- top-left
- top-right
- dark-cyan
- dark-gray
- dark-green
- dark-magenta
- dark-purple
- dark-teal
- light-cyan
- light-gray
- light-green
- light-magenta
- light-purple
- light-teal
- order-1-cyan
- order-10-magenta
- order-11-purple
- order-12-teal
- order-2-gray
- order-3-green
- order-4-magenta
- order-5-purple
- order-6-teal
- order-7-cyan
- order-8-gray
- order-9-green
- lg
- md
- sm
- lg
- md
- sm
- xs
- one
- three
- two
- lg
- sm
- bottom
- left
- right
- top
- dark
- light
- left
- right
- narrow
- wide
- "403"
- "404"
- critical
- custom
- default
- dual-button
- error
- fatal
- ghost
- group
- in-progress
- info
- link
- major-warning
- minor-warning
- noData
- normal
- noTags
- notFound
- notifications
- pending
- primary
- running
- single-button
- tertiary
- unauthorized
- undefined
- unknown
- user
- left
- top
- bottom
- bottom-left
- bottom-right
- left
- left-bottom
- left-top
- right
- right-bottom
- right-top
- top
- top-left
- top-right
- default
- tag
- left
- right
- ghost
- primary
- bottom
- top
- left
- right
- lg
- md
- sm
- xs
- ghost
- secondary
- bottom
- top
- 2xl
- default
- lg
- md
- narrow
- sm
- wide
- xl
- xs
- active
- complete
- default
- error
- fail
- finished
- in-progress
- inactive
- incomplete
- success
- dark
- light
- default
- large
- bottom
- top
- bottom
- bottom-left
- bottom-right
- left
- right
- top
- top-left
- top-right
- end
- start
- auto
- checkbox
- date
- expand
- manual
- number
- radio
- selection
- text
- textarea
- tooltip
- batch
- instant
- Hierarchical
- narrow
- Non-Hierarchical
- wide
- lower
- normal
- horizontal
- vertical
- json
- txt
- json
- txt
- bottom
- bottom-left
- bottom-right
- left
- right
- top
- top-left
- top-right
- floating
- stacked
- tooltip
- and
- or
- condition
- newGroup
- subGroup
- benign
- critical
- high
- low
- medium
- unknown
- bottom
- bottom-left
- bottom-right
- left
- right
- top
- top-left
- top-right
- danger
- primary
- secondary
- tertiary
- password
- text
- long
- narrow
- short
- xl
- danger
- danger--ghost
- danger--tertiary
- ghost
- primary
- secondary
- tertiary
- h1
- h2
- h3
- h4
- h5
- h6
- h2
- h3
- h4
- h5
- h6
- contain
- cover
- fill
- none
- lg
- md
- sm
- horizontal
- vertical
npm:
dependencies: null
js:
functions: {}
tokens: null