# gender-options

> A lightweight package to provide easy lists of gender options for use in web forms.

Latest version **1.0.0** (published 2021-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install gender-options
pnpm add gender-options
yarn add gender-options
bun add gender-options
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-03-31 |
| First published | 2018-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Aimee Gamble-Milner |
| Maintainers | aimee.gm |

## Links

- npm: https://www.npmjs.com/package/gender-options
- Repository: https://github.com/aimee-gm/gender-options
- Homepage: https://github.com/aimee-gm/gender-options#readme
- Issues: https://github.com/aimee-gm/gender-options/issues
- npm.io page: https://npm.io/package/gender-options

## Recent versions

- 1.0.0 (latest) — 2021-03-31
- 1.0.0-5 — 2018-11-11
- 1.0.0-4 — 2018-11-10
- 1.0.0-3 — 2018-11-07
- 1.0.0-2 — 2018-11-07
- 1.0.0-1 — 2018-11-07

## README

# Gender-options

A lightweight package to provide easy lists of gender options for use in web forms.

[![NPM Version](https://img.shields.io/npm/v/gender-options.svg)](https://www.npmjs.com/package/gender-options)
[![Build Status](https://travis-ci.org/aimee-gm/gender-options.svg?branch=master)](https://travis-ci.org/aimee-gm/gender-options)
![MIT License](https://img.shields.io/github/license/aimee-gm/gender-options.svg)

## Installation

To install via `npm`:

```shell
npm install --save gender-options
```

## Usage

```javascript
const { genderOptions } = require('gender-options');
```

or

```javascript
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:

```javascript
// 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](./CONTRIBUTING.md) to add to the lists.

---
_Source: https://npm.io/package/gender-options · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._