Skip to content

Add shared API reference descriptions to copyDocDefinitions #15047

Description

@DintaMel

monday.com sync: #12858137329

Which Component

N/A

Description

In #14293, we set up @copyDoc infrastructure so that we have a single source of truth for shared API reference descriptions. Descriptions with agreed upon shared verbiage were added to copyDocDefinitions. Below are additional shared properties that are not yet in copyDoc. We should align on verbiage, add them to copyDocDefinitions, and replace existing descriptions with the @copyDoc tag. For usage instructions, refer to wiki for shared definitions using @copyDoc.

Note

  • Numbers in parentheses are counts of how many times the property/method is used publicly
  • "🚧" indicates properties from previous discussions that were undecided in WebGIS/calcite-design-system/discussions in early 2026

Properties

  • scale(69) 🚧
  • disabled(57) 🚧
  • iconFlipRtl(29) 🚧
  • value(21) 🚧
  • loading(19)
  • status(19)
  • icon(18) 🚧
  • numberingSystem(16)
  • selected(16) 🚧
  • required(15)
  • layout(14) 🚧
  • validationIcon(14)
  • validationMessage(14) 🚧
  • alignment(12)
  • open(12) 🚧
  • placement(12) 🚧
  • selectionMode(11) 🚧
  • appearance(10) 🚧
  • max(10)
  • min(10)
  • placeholder(10)
  • readOnly(10)
  • expanded(9)
  • width(9) 🚧
  • active(8) 🚧
  • clearable(7)
  • groupSeparator(7) 🚧
  • href(7)
  • kind(7) 🚧
  • selectedItems(7)
  • focusTrapDisabled(6)
  • rel(6)
  • target(6)
  • text(6) 🚧
  • type(6)
  • maxLength(5)
  • minLength(5)
  • position(5)
  • selectionAppearance(5)
  • step(5)
  • widthScale(5)
  • autocomplete(4)
  • beforeClose(4)
  • focusTrapOptions(4)
  • menuOpen(4)
  • monthStyle(4)
  • prefixText(4)
  • range(4)
  • selectedItem(4)
  • suffixText(4)
  • activeDate(3)
  • calendars(3)
  • canPull(3)
  • canPut(3)
  • collapsed(3)
  • collapsible(3)
  • displayMode(3)
  • download(3)
  • dragEnabled(3)
  • filterProps(3)
  • group(3)
  • inlineEditable(3)
  • inlineEditableAfterConfirm(3)
  • inlineEditableControls(3)
  • maxItems(3)
  • menuPlacement(3) 🚧
  • offsetDistance(3)
  • offsetSkidding(3)
  • pattern(3)
  • resizable(3)
  • sortDisabled(3)
  • thumbnail(3)

Methods

  • setFocus(69)
  • reposition(7)
  • selectText(5)
  • scrollContentTo(4)
  • updateFocusTrapElements(4)
  • updateSize(3)

Resources

No response

Metadata

Metadata

Labels

Calcite (dev)Issues logged by Calcite developers.docsIssues relating to documentation updates only.estimate - 8Requires input from team, consider smaller steps.p - highIssue should be addressed in the current milestone, impacts component or core functionality

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions