gender-options
v1.0.0
Published
A lightweight package to provide easy lists of gender options for use in web forms.
Downloads
83
Readme
Gender-options
A lightweight package to provide easy lists of gender options for use in web forms.
Installation
To install via npm
:
npm install --save gender-options
Usage
const { genderOptions } = require('gender-options');
or
import { genderOptions } from 'gender-options';
Data structure
genderOptions
is an object with three properties:
genderOptions.basic
- a minimal list of gender identities for the most basic of forms (e.g. radio buttons)genderOptions.standard
- a wide list of gender identities to allow for an (almost) fully-inclusive form without all possible options (e.g. select box)genderOptions.extended
- complete list of gender identities where length is no issue (e.g. typeahead)
The three lists are arrays of objects with label
and value
properties sorted alphabetically:
// EXAMPLE LIST
[
{
label: 'Female',
value: 'male',
},
{
label: 'Non-binary',
value: 'nonbinary'
},
...
]
Contributing and completeness
This project is currently incomplete, so please suggest new gender identities to add to the lists.