WixDesignSystemDefaultPropsProvider

Components/Mechanisms

Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/wixdesignsystemdefaultpropsprovider

Overview

WixDesignSystemDefaultPropsProvider sets default props for supported components across a subtree. Wrap part of your app, pass a defaults map keyed by component name, and every matching component inside inherits those props, unless an instance sets the prop itself. Useful for enforcing consistent size, skin, or other variants in a section without repeating props on each component.

The provider context is a shared singleton, so when several copies of @wix/design-system are loaded on one page (micro-frontends, module federation), components from every copy honour the same provider as long as they render inside it. A separate React root needs its own provider.

Supported keys:

  • Accordion
  • AngleInput
  • AutoComplete
  • Button
  • CloseButton
  • ColorInput
  • ComposerSidebar
  • Dock
  • Dropdown
  • IconButton
  • Input
  • InputArea
  • MultiSelect
  • MultiSelectCheckbox
  • NumberInput
  • PopoverMenu
  • RichTextInputArea
  • Search
  • SidePanel
  • SidePanel.Header
  • TableActionCell
  • TableListItem
  • TextButton
  • Thumbnail
  • TimeInput
  • ToggleButton

Do

  • Use it to enforce consistent variants, such as size, skin and priority, across a section like a toolbar, side panel or form.
  • Set the prop on an instance when one component needs to differ. An instance prop always wins.

Don't

  • Don't pass defaults as an inline object literal in hot render paths. Pass a stable reference when re-renders matter.
  • Don't rely on it for required props. It fills only undefined props, so a prop explicitly set to undefined still gets the default.

Feature examples

Basic example

Overrides the default property values for a project

Copy

Code

Copy

Props

NameTypeDefaultDescription
childrenReactNode—Sets the subtree the default props apply to.
defaults (required)WixDesignSystemDefaultProps—Sets default props per component, keyed by component name, for example { Button: { size: 'small' } }. A prop passed to the component itself takes precedence. A nested provider replaces these defaults instead of merging with them.

Testkit

No testkit for this component — it doesn't expose a unidriver testkit.

Changelog

  • 1.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.332.0 (2026-10-05) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.329.0 (2026-09-24) — maintenance release, no component-specific changes
  • 1.328.0 (2026-09-22) — maintenance release, no component-specific changes
  • 1.327.0 (2026-09-21) — maintenance release, no component-specific changes
  • 1.326.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.320.0 (2026-09-03) — maintenance release, no component-specific changes
  • 1.315.0 (2026-08-20) — maintenance release, no component-specific changes
  • 1.312.0 (2026-08-14) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.307.0 (2026-08-03) — maintenance release, no component-specific changes
  • 1.306.0 (2026-07-31) — maintenance release, no component-specific changes
  • 1.303.0 (2026-07-23) — maintenance release, no component-specific changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.290.0 (2026-06-18) — maintenance release, no component-specific changes
  • 1.289.0 (2026-06-17) — maintenance release, no component-specific changes

Last updated: 21 October 2026

Did this help?