Decide on initial* vs default* conventions for v11

[joshblack]

We would like to come up with consistent definitions for when to use initial* and default* prefixed props in our codebase.

Currently, initial is being used 4 times:

• initialSelectedItem
• initialSelectedItems
• initialChecked
• initialPage

default* is being used 6 times:

• defaultValue
• defaultChecked
• defaultExpanded
• defaultToggled
• defaultSelected
• defaultOpen

Background

Historically, defaultValue and value have been used for uncontrolled and controlled components (Link). This convention is useful because a consumer would like to set the value without actually controlling the component. In this case, they would use defaultValue to provide the initial value for the component without controlling it.

Our perspective

We would like to use default* as the standard prefix for setting the initial value of a prop. In particular, this comes up in controlled and uncontrolled components.

Links & Resources

• Controlled vs uncontrolled
  • https://reactjs.org/docs/uncontrolled-components.html#default-values
  • https://codesandbox.io/s/jovial-dubinsky-5vkih?file=/src/App.js
• Definitions
  • initial --- oxford --- "existing or occurring at the beginning."
  • default --- oxford --- "(of a computer program or other mechanism) revert automatically to (a preselected option)."
  • default --- merriam-webster --- "a selection automatically used by a program in the absence of a choice made by the user"
• Design Systems / Libraries
  • Radix UI -> uses default for initial value
  • Reach UI -> uses default in a similar way to uncontrolled/controlled
  • Material UI -> uses default for initial value
  • Chakra UI -> uses default for initial value

[joshblack]

Action items

• Update initialPage to defaultPage
• Update initialChecked to defaultChecked
• We currently use initialSelectedItem and initialSelectedItems and want to make sure defaultSelectedItem and defaultSelectedItems are also supported