Socket
Socket
Sign inDemoInstall

@material/react-select

Package Overview
Dependencies
7
Maintainers
13
Versions
19
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/react-select


Version published
Maintainers
13
Created

Readme

Source

React Select

MDC React Select is component for MDC Select. Please see MDC Select.

Installation

npm install @material/react-select

Usage

Styles

with Sass:

import '@material/react-list/index.scss';
import '@material/react-menu-surface/index.scss';
import '@material/react-menu/index.scss';
import '@material/react-select/index.scss';

with CSS:

import '@material/react-list/dist/menu.css';
import '@material/react-menu-surface/dist/menu.css';
import '@material/react-menu/dist/menu.css';
import '@material/react-select/dist/select.css';

Javascript Instantiation

React Select requires at least one <Option> element as a child and a label prop.

import React from 'react';
import Select, {Option} from '@material/react-select';

class MyApp extends React.Component {
  state = {value: 'pomsky'};

  render() {
    return (
      <Select
        label='Choose Dog'
        value={this.state.value}
        onChange={(evt) => this.setState({value: evt.target.value})}
      >
        <Option value='pomsky'>Pomsky</Option>
        <Option value='goldenDoodle'>Golden Doodle</Option>
      </Select>
    );
  }
}

NOTE: In order to get access to the value, you must add an onChange handler, which accepts an event and updates the value of the select as shown above.

Enhanced Select

React Select provides a Material styled select, instead of the default native drop down.

import React from 'react';
import Select, {Option} from '@material/react-select';

class MyApp extends React.Component {
  state = {value: 'pomsky'};

  onEnhancedChange = (index, item) => (
    this.setState({value: item.getAttribute('data-value')})
  );

  render() {
    return (
      <Select
        enhanced
        label='Choose Dog'
        value={this.state.value}
        onEnhancedChange={this.onEnhancedChange}
      >
        <Option value='pomsky'>Pomsky</Option>
        <Option value='goldenDoodle'>Golden Doodle</Option>
      </Select>
    );
  }
}
Shorthand options

If the option elements do not require anything unique, you can omit passing this.props.children and set the options prop.

This options shorthand is most useful when your select options come in the form of JSON. Typically, when building a select, the options will be backed by an array of objects or strings (either from an API endpoint or a JSON File). If the label and value key names exist in the array of objects, you can run a map function over that array as shown below.

import React from 'react';
import Select from '@material/react-select';

class MyApp extends React.Component {
  state = {value: 'pomsky'};

  render() {
    const options = [{
      label: 'Pomsky',
      value: 'pomsky',
    }, {
      label: 'Golden Doodle',
      value: 'goldenDoodle',
      disabled: true,
    }];

    return (
      <Select
        label='Choose Dog'
        onChange={(evt) => this.setState({value: evt.target.value})}
        value={this.state.value}
        options={options}
      />
    );
  }
}

NOTE: If you want a floating label to act as a placeholder, you will need an empty option as documented in the MDC Web Select.

Props

Prop NameTypeDescription
childrenArray{Element}/ElementArray of <option> elements or a single <option> element.
classNameStringAn optional class added to the .mdc-select element.
disabledBooleanDisables the select.
enhancedBooleanEnables the enhanced select.
floatingLabelClassNameStringAn optional class added to the floating label element.
idStringId of the <select> element.
labelStringLabel text that appears as the floating label.
lineRippleClassNameStringAn optional class added to the line ripple element.
selectClassNameStringAn optional class added to the native <select> element.
notchedOutlineClassNameStringAn optional class added to the notched outline element. Only applied if props.outlined is enabled.
outlinedBooleanEnables outlined variant.
optionsArray{String/Object}Array of strings or objects to be used as options. To be used instead of <option> elements passed as this.props.children. If its an array of strings, then the string value will be used as the label and value of the <option> tag.
valueStringOptional property used to control the selected value outside of <Select> component.
afterChange(value: string) => voidCallback for when the select value changed.
onEnhancedChange(index: number, target: Element) => voidCallback for when the enhanced select receives a new value.
onChange(evt: React.ChangeEvent => void)Callback for when the native select receives a new value.
helperTextSelectHelperTextElement to appear as helper text of the select element.
leadingIconSelectIconElement to appear as leading icon of the select element.

Option

The <Option /> component is a provided component to be used for both the enhanced and native select.

Use with Native Select

When used in the native select, the <Option /> accepts all the same props as the native <option /> tag.

<Option value='goldenDoodle'>Golden Doodle</Option>
<Option value='pomsky'>Pomsky</Option>
Use with Enhanced Select

When used in the enhanced select, the <Option /> component extends from MenuListItem. For your convience other auxilary components of menu are exported from select.

Sass Mixins

Sass mixins may be available to customize various aspects of the Components. Please refer to the MDC Web repository for more information on what mixins are available, and how to use them.

Advanced Sass Mixins

Keywords

FAQs

Last updated on 22 Jul 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc