@carbon/react
Version:
React components for the Carbon Design System
973 lines (971 loc) • 20.8 kB
YAML
# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json
version: 1
projectId: fd89d12b-6a39-48b4-adf4-30c94dc0dddd
endpoint: https://www-api.ibm.com/ibm-telemetry/v1/metrics
collect:
jsx:
elements:
allowedAttributeNames:
# General
- _autoEnablePresence
- _presenceId
- accept
- action
- actionButtonLabel
- activation
- active
- addFocusListeners
- align
- allowCustomValue
- allowEmpty
- aria-controls
- aria-current
- aria-label
- aria-labelledby
- ariaLabel
- as
- autoAlign
- autoComplete
- backgroundToken
- border
- buttonKind
- caption
- checked
- children
- className
- clearAnnouncement
- clearSelectionDescription
- clearSelectionText
- closeButtonLabelText
- closeModal
- closeOnActivation
- cols
- colSpan
- compareItems
- condensed
- contained
- count
- danger
- dangerDescription
- datePickerType
- decorator
- defaultChecked
- defaultExpanded
- defaultOpen
- defaultSelected
- defaultSelectedIndex
- defaultValue
- density
- description
- dir
- direction
- disabled
- disableWheel
- downshiftActions
- downshiftProps
- dropShadow
- element
- enableCounter
- enterDelayMs
- expanded
- expandIconDescription
- feedback
- feedbackTimeout
- flipped
- focusTrap
- formatOptions
- fullWidth
- gap
- hasDivider
- hasIconOnly
- hasRoundedCorners
- hasScrollingContent
- head
- headers
- heading
- helperText
- hideCloseButton
- hideLabel
- hidePasswordLabel
- highContrast
- href
- iconClass
- iconDescription
- id
- indeterminate
- index
- initialSelectedItem
- initialSelectedItems
- inline
- innerRef
- inputMode
- inputProps
- invalid
- invalidText
- isActive
- isCondensed
- isCurrentPage
- isExpanded
- isExpressive
- isFlush
- isFullWidth
- isOpen
- isPassword
- isSelected
- isSideNavExpanded
- isSortable
- items
- itemText
- itemToElement
- itemToString
- kind
- label
- labelPosition
- labelText
- large
- launcherButtonRef
- leaveDelayMs
- legendId
- legendText
- level
- light
- lineCount
- loadingDescription
- loadingIconDescription
- loadingStatus
- locale
- lowContrast
- max
- maxCount
- menuAlignment
- menuOffset
- menuOffsetFlip
- menuOptionsClass
- menuTarget
- min
- modalHeading
- modalLabel
- mode
- multiple
- name
- narrow
- nested
- noTrailingSlash
- onActionButtonClick
- onAddFiles
- onBlur
- onCancel
- onChange
- onClear
- onClick
- onClose
- onCloseButtonClick
- onDelete
- onExpand
- onFocus
- onInputChange
- onInputValueChange
- onKeyDown
- onKeyUp
- onLoadingSuccess
- onMenuChange
- onMouseEnter
- onMouseLeave
- onMouseUp
- onOpen
- onRequestClose
- onRequestSubmit
- onSecondarySubmit
- onSelect
- onToggle
- onToggleClick
- onTogglePasswordVisibility
- open
- ordered
- orientation
- page
- pageActions
- paragraph
- passiveModal
- pattern
- placeholder
- prefix
- preventCloseOnClickOutside
- primaryButtonDisabled
- primaryButtonText
- readOnly
- ref
- rel
- renderIcon
- renderSelectedItem
- required
- role
- rowCount
- rows
- scrollIntoView
- secondaryButtons
- secondaryButtonText
- secondaryLabel
- selected
- selectedIndex
- selectedItem
- selectedItems
- selection
- selectionFeedback
- selectorPrimaryFocus
- selectorsFloatingMenus
- shouldFilterItem
- showPasswordLabel
- size
- slug
- small
- sortItems
- status
- statusIconDescription
- step
- stickyHeader
- subtitle
- tabIndex
- target
- text
- theme
- title
- titleId
- titleText
- tooltipAlignment
- tooltipDropShadow
- tooltipHighContrast
- tooltipPosition
- totalItems
- translateWithId
- type
- typeahead
- useStaticWidth
- useTitleInItem
- value
- valueSelected
- vertical
- warn
- warnText
- width
# AccordionItem
- handleAnimationEnd
- onHeadingClick
- renderExpando
- renderToggle
# ActionableNotification
- closeOnEscape
- hasFocus
# AILabel
- AILabelContent
- aiText
- aiTextLabel
- onRevertClick
- revertActive
- revertLabel
- slugLabel
- textLabel
# AISkeletonIcon
- style
# AspectRatio
- ratio
# ButtonSet
- stacked
# ChatButton
- isQuickAction
# ClickableTile
- clicked
# CodeSnippet
- copyButtonDescription
- copyText
- hideCopyButton
- maxCollapsedNumberOfRows
- maxExpandedNumberOfRows
- minCollapsedNumberOfRows
- minExpandedNumberOfRows
- showLessText
- showMoreText
- wrapText
# Column
- lg
- md
- sm
- span
- xlg
# ComposedModal
- containerClassName
# ContainedList
- isInset
# ContentSwitcher
- selectionMode
# Copy
- onAnimationEnd
# DataTableSkeleton
- columnCount
- compact
- showHeader
- showToolbar
- zebra
# DatePicker
- allowInput
- appendTo
- closeOnSelect
- dateFormat
- disable
- enable
- maxDate
- minDate
- nextMonthAriaLabel
- parseDate
- prevMonthAriaLabel
- short
# DatePickerSkeleton
- range
# DefinitionTooltip
- definition
- openOnHover
- tooltipText
- triggerClassName
# Dialog
- ariaDescribedBy
- ariaLabelledBy
- focusAfterCloseRef
- modal
# DismissibleTag
- dismissTooltipAlignment
- dismissTooltipLabel
- tagTitle
# ErrorBoundary
- fallback
# ExpandableTile
- tileCollapsedIconText
- tileCollapsedLabel
- tileExpandedIconText
- tileExpandedLabel
- tileMaxHeight
- tilePadding
# FeatureFlags
- enableDialogElement
- enableEnhancedFileUploader
- enableExperimentalFocusWrapWithoutSentinels
- enableFocusWrapWithoutSentinels
- enablePresence
- enableTreeviewControllable
- enableV12DynamicFloatingStyles
- enableV12Overflowmenu
- enableV12TileDefaultIcons
- enableV12TileRadioIcons
- flags
# Filename
- aria-describedby
# FileUploader
- buttonLabel
- filenameStatus
- labelDescription
- labelTitle
# FileUploaderButton
- disableLabelChanges
# FileUploaderItem
- errorBody
- errorSubject
- uuid
# FilterableMultiSelect
- filterItems
# FluidMultiSelect
- isFilterable
# FluidTimePickerSkeleton
- isOnlyTwo
# FormGroup
- message
- messageText
# GridSettings
- subgrid
# HeaderContainer
- render
# HeaderMenu
- focusRef
- menuLinkName
- renderMenuContent
# HeaderMenuButton
- isCollapsible
- renderCloseIcon
- renderMenuIcon
# HeaderPanel
- onHeaderPanelFocus
# IconButton
- badgeCount
- wrapperClasses
# IconTab
- badgeIndicator
# InlineLoading
- onSuccess
- successDelay
# Layer
- withBackground
# LinkBase
- visited
# ListBox
- invalidTextId
- warnTextId
# ListBoxField
- aria-haspopup
# ListBoxMenuItem
- isHighlighted
# ListBoxSelection
- clearSelection
- onClearSelection
- selectionCount
# Loading
- withOverlay
# Menu
- containerRef
- legacyAutoalign
- x
- y
# MenuButton
- menuBackgroundToken
- menuBorder
# MenuItem
- shortcut
# MenuItemRadioGroup
- defaultSelectedItem
# Modal
- alert
- closeButtonLabel
- modalAriaLabel
- shouldSubmitOnEnter
# ModalBody
- hasForm
# ModalFooter
- inputref
- primaryClassName
- secondaryClassName
# ModalHeader
- buttonOnClick
- closeClassName
- closeIconClassName
- labelClassName
- titleClassName
# ModalWrapper
- buttonTriggerClassName
- buttonTriggerText
- handleOpen
- handleSubmit
- modalBeforeContent
- modalText
- renderTriggerButtonIcon
- shouldCloseAfterSubmit
- triggerButtonIconDescription
- triggerButtonKind
- withHeader
# NotificationButton
- notificationType
# NumberInput
- hideSteppers
- stepStartValue
- validate
# OrderedList
- native
# OverflowMenuItem
- closeMenu
- handleOverflowMenuItemFocus
- isDelete
- onMouseDown
- requireTitle
- wrapperClassName
# PageHeaderBreadcrumbBar
- contentActions
- contentActionsFlush
- pageActionsFlush
# PageHeaderContent
- contextualActions
# PageHeaderContentPageActions
- actions
- menuButtonLabel
# PageHeaderTabBar
- tags
# PageSelector
- currentPage
- totalPages
# Pagination
- backwardText
- forwardText
- initialPage
- isLastPage
- itemRangeText
- itemsPerPageText
- pageInputDisabled
- pageNumberText
- pageRangeText
- pageSize
- pageSizeInputDisabled
- pageSizes
- pagesUnknown
- pageText
# PaginationNav
- disableOverflow
- itemsShown
- loop
# Popover
- alignmentAxisOffset
- autoAlignBoundary
- caret
- isTabTip
# ProgressIndicator
- currentIndex
- spaceEqually
# ProgressStep
- complete
- current
- overflowTooltipProps
- tooltipId
# Select
- noLabel
# SelectItem
- hidden
# ShapeIndicator
- textSize
# SideNav
- addMouseListeners
- inert
- isChildOfHeader
- isFixedNav
- isPersistent
- isRail
- onOverlayClick
- onSideNavBlur
# SideNavFooter
- assistiveText
# SideNavSwitcher
- options
# Slider
- ariaLabelInput
- formatLabel
- hideTextInput
- inputType
- maxLabel
- minLabel
- onInputKeyUp
- onRelease
- stepMultiplier
- unstable_ariaLabelInputUpper
- unstable_nameUpper
- unstable_valueUpper
# SliderSkeleton
- twoHandles
- unstable_ariaLabelHandleUpper
# StructuredListCell
- noWrap
# StructuredListWrapper
- selectedInitialRow
# SwitcherItem
- handleSwitcherItemFocus
# Tab
- renderButton
# Table
- experimentalAutoAlign
- overflowMenuOnHover
- useZebraStyles
# TableBatchActions
- onSelectAll
- shouldShowBatchActions
- totalCount
- totalSelected
# TableBody
- aria-live
# TableCell
- hasAILabelHeader
# TableContainer
- aiEnabled
# TableExpandHeader
- enableExpando
- enableToggle
# TableExpandRow
- expandHeader
# TableHeader
- isSortHeader
- scope
- sortDirection
# TableSelectRow
- radio
# TableToolbarFilter
- onApplyFilter
- onResetFilter
# TableToolbarSearch
- persistent
- searchContainerClass
# TabList
- iconSize
- leftOverflowButtonProps
- rightOverflowButtonProps
- scrollDebounceWait
# Tabs
- dismissable
- onTabCloseRequest
# TabsVertical
- height
# TagBase
- filter
# TextArea
- counterMode
# TextDirection
- getTextDirection
# TileGroup
- legend
# TimePicker
- maxLength
- warning
- warningText
# ToastNotification
- timeout
# Toggle
- defaultToggled
- labelA
- labelB
- toggled
# TreeNode
- defaultIsExpanded
- depth
- onNodeFocusEvent
- onTreeSelect
# TreeView
- multiselect
- onActivate
# React
- key
- ref
allowedAttributeStringValues:
# General - activation
- automatic
- manual
# General - align
- bottom
- bottom-end
- bottom-left
- bottom-right
- bottom-start
- center
- end
- left
- left-bottom
- left-end
- left-start
- left-top
- right
- right-bottom
- right-end
- right-start
- right-top
- start
- top
- top-end
- top-left
- top-right
- top-start
# General - aria-current
- date
- "false"
- location
- page
- step
- time
- "true"
# General - backgroundToken
- background
- layer
# General - buttonKind
- danger
- danger--ghost
- danger--primary
- danger--tertiary
- ghost
- primary
- secondary
- tertiary
# General - datePickerType
- range
- simple
- single
# General - density
- condensed
- normal
# General - dir
- auto
- ltr
- rtl
# General - direction
- bottom
- top
# General - inputMode
- decimal
- email
- none
- numeric
- search
- tel
- text
- url
# General - kind
- caution-major
- caution-minor
- cautious
- critical
- danger
- default
- disclosed
- draft
- error
- failed
- ghost
- high
- in-progress
- incomplete
- info
- info-square
- informative
- inline
- low
- medium
- normal
- not-started
- on-page
- pending
- primary
- secondary
- stable
- succeeded
- success
- tertiary
- undefined
- unknown
- warning
- warning-alt
# General - labelPosition
- left
- right
# General - level
- "0"
- "1"
- "2"
# General - loadingStatus
- active
- error
- finished
- inactive
# General - locale
- ar
- at
- az
- be
- bg
- bn
- bs
- cat
- cs
- cy
- da
- de
- en
- eo
- es
- et
- fa
- fi
- fo
- fr
- ga
- gr
- he
- hi
- hr
- hu
- id
- is
- it
- ja
- ka
- km
- ko
- kz
- lt
- lv
- mk
- mn
- ms
- my
- nl
- no
- pa
- pl
- pt
- ro
- ru
- si
- sk
- sl
- sq
- sr
- sv
- th
- tr
- uk
- uz
- uz_latn
- vn
- zh
- zh_tw
# General - menuAlignment
- bottom
- bottom-end
- bottom-start
- top
- top-end
- top-start
# General - mode
- basic
- css-grid
- flexbox
- full
# General - orientation
- horizontal
- vertical
# General - role
- alert
- alertdialog
- dialog
- log
- status
# General - selectionFeedback
- fixed
- top
- top-after-reopen
# General - size
- "16"
- "20"
- 2xl
- 2xs
- big
- field
- lg
- md
- mini
- sm
- small
- xl
- xs
# General - status
- active
- complete
- edit
- error
- finished
- inactive
- uploading
# General - theme
- g10
- g100
- g90
- white
# General - tooltipAlignment
- center
- end
- start
# General - tooltipPosition
- bottom
- left
- right
- top
# General - type
- blue
- button
- cool-gray
- cyan
- default
- gray
- green
- high-contrast
- indented
- inline
- magenta
- multi
- number
- outline
- password
- purple
- red
- reset
- single
- submit
- teal
- text
- warm-gray
# AspectRatio - ratio
- 16x9
- 1x1
- 1x2
- 2x1
- 2x3
- 3x2
- 3x4
- 4x3
- 9x16
# ContentSwitcher - selectionMode
- automatic
- manual
# DismissibleTag - dismissTooltipAlignment
- bottom
- bottom-end
- bottom-start
- left
- left-end
- left-start
- right
- right-end
- right-start
- top
- top-end
- top-start
# FileUploader - filenameStatus
- complete
- edit
- uploading
# MenuButton - menuBackgroundToken
- background
- layer
# ModalWrapper - triggerButtonKind
- danger
- danger--ghost
- danger--primary
- danger--tertiary
- ghost
- primary
- secondary
- tertiary
# NotificationButton - notificationType
- actionable
- inline
- toast
# Popover - autoAlignBoundary
- clippingAncestors
# ShapeIndicator - textSize
- "12"
- "14"
# TableBody - aria-live
- assertive
- off
- polite
# TableHeader - sortDirection
- ASC
- DESC
- NONE
# TabList - iconSize
- default
- lg
# TextArea - counterMode
- character
- word
npm:
dependencies: null
js:
functions: {}
tokens: null