@felixclement/vue-accessible-selects v1.12.0

vue-accessible-selects

Current Development

This entire repo is very much in an alpha state, and should currently be used only within internal Politico projects, as props / events / classes remain fluid. However, we are working towards a 1.0.0 release, and want to capture our relevant bugs fixed during that process.

References

• Current guiding blogpost: https://www.24a11y.com/2019/select-your-poison-part-2/
• Codepen from blogpost: https://codepen.io/smhigley/pen/gObMVzv (#1 ≈ SelectSingle, #3 ≈ SelectMulti)
• Select single implementation: https://github.com/microsoft/sonder-ui/tree/master/src/components/select
• Select multiple implementation: https://github.com/microsoft/sonder-ui/tree/master/src/components/multiselect

Current Usage (updated 9/25/20)

npm i @politico/vue-accessible-components

// In component

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

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

export default Vue.extend({
	components: { SelectSingle, SelectMulti },
	data() {
		return {
			sampleOptions,
			selectSingleValue: {} as SelectOption,
			selectMultiValues: [] as SelectOption[]
		}
	},
	methods: {
		handleSelectEvent(selectedValue: SelectOption) {
			// selectedValue will be the most recently selected value
			// *generally not necessary*, if state can be handled w/ v-model alone
		},
		handleRemoveEvent(selectedValue: SelectOption) {
			// selectedValue will be the most recently removed value
			// *generally not necessary*, if state can be handled w/ v-model alone
		},
		handleSearchChangeEvent(inputValue: string) {
			// inputValue will be the current user-provided search string
			// primarily useful for making autocomplete calls
		}
	}
})

<!-- In component -->
<SelectSingle
	v-model="selectSingleValue"
	:options="sampleOptions"
	label="My Single Select"
	:labelIsVisible="true"
	@select="handleSelectEvent"
/>

<SelectMulti
	v-model="selectMultiValues"
	:options="sampleOptions"
	label="My Multiple Select"
	:labelIsVisible="true"
	placeholder="Default Text to Display"
	@select="handleSelectEvent"
	@remove="handleRemoveEvent"
	@searchChange="handleSearchChangeEvent"
/>

// 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();

or

// In any .scss file
// Customized, using any of the optional SCSS vars provided, as well as targeting any specific classes
@import '~@politico/vue-accessible-selects/styles';

@include selects(
	$primary-background-color: white,
	$closed-background-color: lightgray,

	$selected-color: white,
	$selected-background-color: blue,

	$hover-color: white,
	$hover-background-color: darkblue,
	
	$font-size: 14px,
	$open-border-color: darkgray
) {
	.combo-input {  /* some CSS styles applied to the combo-input for *both* Single & Multi; see `Custom Styling` for available classes */ }
}

@include select-single() {
	.combo-input {  /* some CSS styles applied to the combo-input for *only* Single */ }
}

@include select-multi(
	$selected-option-pill-color: blue,
	$selected-option-pill-background-color: lightblue
) {
	.combo-input {  /* some CSS styles applied to the combo-input for *only* Multi */ }
}

Custom Styling

As we determine the most-commonly externally-referenced classes, we'll add them here

• .combo-input
• .combo-menu