alpha

SearchWithin

A SearchWithin combines a SearchField and a Picker into a single group. This allows a user to constrain the scope of their search to a particular category, for example.

installyarn add @react-spectrum/searchwithin
version3.0.0-alpha.6
usageimport {SearchWithin} from '@react-spectrum/searchwithin'

Example#


<SearchWithin label="Search">
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search">
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search">
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">
      All
    </Item>
    <Item key="campaigns">
      Campaigns
    </Item>
    <Item key="audiences">
      Audiences
    </Item>
    <Item key="tags">
      Tags
    </Item>
  </Picker>
</SearchWithin>

Content#


SearchWithin accepts exactly two children: a Search Field and a Picker. The SearchField element should be the first child passed into the SearchWithin.

Labeling#


SearchWithin can be labeled using the label prop. This will add a visible label, and be used by the SearchField and the Picker's aria-labelledby, as well as by the group's aria-label.

Internationalization#


In order to internationalize a SearchWithin, a localized string should be passed to the label prop. When the necessityIndicator prop is set to "label", a localized string will be provided for "(required)" or "(optional)" automatically.

Props#


NameTypeDefaultDescription
children[ ReactElement, ReactElement ]The SearchField and Picker contained within the SearchWithin.
isDisabledbooleanWhether the children should be disabled. Propagated to both children.
labelPositionLabelPosition'top'The label's overall position relative to the element it is labeling.
labelAlignAlignment'start'The label's horizontal alignment relative to the element it is labeling.
necessityIndicatorNecessityIndicator'icon'Whether the required state should be shown as an icon or text.
isRequiredbooleanWhether the label is labeling a required field or group.
labelReactNodeThe content to display as the label.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Disabled#

<SearchWithin label="Search" isDisabled>
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search" isDisabled>
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin
  label="Search"
  isDisabled
>
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">
      All
    </Item>
    <Item key="campaigns">
      Campaigns
    </Item>
    <Item key="audiences">
      Audiences
    </Item>
    <Item key="tags">
      Tags
    </Item>
  </Picker>
</SearchWithin>

Read only#

<SearchWithin label="Search">
  <SearchField value="Read Only" isReadOnly />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search">
  <SearchField value="Read Only" isReadOnly />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search">
  <SearchField
    value="Read Only"
    isReadOnly
  />
  <Picker defaultSelectedKey="all">
    <Item key="all">
      All
    </Item>
    <Item key="campaigns">
      Campaigns
    </Item>
    <Item key="audiences">
      Audiences
    </Item>
    <Item key="tags">
      Tags
    </Item>
  </Picker>
</SearchWithin>

Label Position#

<SearchWithin label="Search" labelPosition="side">
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search" labelPosition="side">
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin
  label="Search"
  labelPosition="side"
>
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">
      All
    </Item>
    <Item key="campaigns">
      Campaigns
    </Item>
    <Item key="audiences">
      Audiences
    </Item>
    <Item key="tags">
      Tags
    </Item>
  </Picker>
</SearchWithin>

Custom width#

<SearchWithin label="Search" width="size-3600" >
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin label="Search" width="size-3600" >
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">All</Item>
    <Item key="campaigns">Campaigns</Item>
    <Item key="audiences">Audiences</Item>
    <Item key="tags">Tags</Item>
  </Picker>
</SearchWithin>
<SearchWithin
  label="Search"
  width="size-3600"
>
  <SearchField />
  <Picker defaultSelectedKey="all">
    <Item key="all">
      All
    </Item>
    <Item key="campaigns">
      Campaigns
    </Item>
    <Item key="audiences">
      Audiences
    </Item>
    <Item key="tags">
      Tags
    </Item>
  </Picker>
</SearchWithin>