@politico/vue-accessible-selects
TypeScript icon, indicating that this package has built-in type declarations

2.0.1-alpha.24 • Public • Published

vue-accessible-selects

npm version

Description: Select & Multi Select implementations for Vue, focused especially on implementing accessibility best practices

Installation

npm i @politico/vue-accessible-selects

Usage

import { SelectSingle, SelectMulti } from '@politico/vue-accessible-selects'

const sampleOptions = [{
	label: 'One Option',
	value: 'one_option'
}, {
	label: 'Another Option',
	value: 'another_option'
}]

export default {
	components: { SelectSingle, SelectMulti },
	data() {
		return {
			sampleOptions,
			selectSingleValue: {},
			selectMultiValues: []
		}
	},
}
<SelectSingle
	v-model="selectSingleValue"
	:options="sampleOptions"
	label="My Single Select"
	:labelIsVisible="true"
/>

<SelectMulti
	v-model="selectMultiValues"
	:options="sampleOptions"
	label="My Multiple Select"
	:labelIsVisible="true"
	placeholder="Default Text to Display"
/>

Custom Styling

Most-commonly externally-referenced classes:

  • .combo-input
  • .combo-menu

References

WARNING! node-sass deprecated

To compile scss code you must use dart sass package as it uses sass:math module for divisions instead of slash https://sass-lang.com/documentation/breaking-changes/slash-div

node-sass is deprecated

// In any .scss file
// Simple, use default styles provided by lib
@import '~@politico/vue-accessible-selects/styles';

@include selects();
@include select-single();
@include select-multi();

for more detailed implementations, checkout the docs site

Package Sidebar

Install

npm i @politico/vue-accessible-selects

Weekly Downloads

35

Version

2.0.1-alpha.24

License

MIT

Unpacked Size

56.8 kB

Total Files

11

Last publish

Collaborators

  • stilessl
  • kherbert
  • guirreri
  • mazet
  • brizandrew
  • bzjin
  • arm5077
  • pfriedr
  • wickidd
  • mshushan-politico
  • rbvea
  • dlazarenko-c-nitka
  • andmilligan
  • caitlinfloyd
  • ewalters-politico
  • tcrite_pol