Gender
Lightweight, dependency-free library for gender-specific terms in multiple languages
English - French - Spanish - Italian - German - Japanese - Chinese - Arabic - Russian
A minimalist library that provides a comprehensive way to handle gender representation in various languages. Zero dependencies, tree-shakeable, and type-safe.
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [Usage](#usage)
- [Basic Usage](#basic-usage)
- [Localization](#localization)
- [Custom Properties](#custom-properties)
- [Capitalization](#capitalization)
- [API Reference](#api-reference)
- [Types](#types)
## Installation
```bash
npm install @matsukky/gender
# or
yarn add @matsukky/gender
# or
bun add @matsukky/gender
```
## Features
- ðŠķ Lightweight
- ðĶ Zero dependencies
- ð Support for multiple languages
- ðĻ Color schemes for each gender
- ð Custom properties support
- ð Automatic capitalization
- ð Rich set of gender-specific terms
- ðŠ Fully typed (TypeScript)
## Usage
### Basic Usage
```typescript
import gender from '@matsukky/gender';
const female = gender('F');
console.log(female.genderName); // "woman"
console.log(female.childTerm); // "girl"
console.log(female.emoji); // "ðš"
const male = gender('MALE'); // Alias support
console.log(male.genderName); // "man"
console.log(male.colors.primary); // "#1e90ff"
const neutral = gender('X');
console.log(neutral.genderName); // "person"
```
### Localization
```typescript
import gender, { locale } from '@matsukky/gender';
// Load French locale
await locale('fr');
const female = gender('F');
console.log(female.genderName); // "femme"
console.log(female.childTerm); // "fille"
```
### Custom Properties
```typescript
import gender from '@matsukky/gender';
// Definition of context-specific terms
const result = gender('F', {
custom: {
occupation: {
F: "actress",
M: "actor",
X: "performer"
},
workplace: {
F: "actresses' room",
M: "actors' room",
X: "performers' room"
},
award: {
F: "best actress",
M: "best actor",
X: "best performance"
}
}
});
// Basic usage
console.log(result.occupation); // "actress"
console.log(result.workplace); // "actresses' room"
// Combination with standard properties
console.log(`${result.title} ${result.genderName}`); // "Mrs woman"
console.log(`${result.occupation} ${result.objectPronoun}`); // "actress her"
// Usage with capitalization
const capitalizedResult = gender('F', {
capitalize: true,
custom: {
occupation: {
F: "actress",
M: "actor",
X: "performer"
}
}
});
console.log(capitalizedResult.occupation); // "Actress"
```
The `gender` function allows extending standard properties with custom terms while maintaining gender consistency. Each custom property must define a value for all three genders (F, M, X) to ensure inclusive usage.
### Capitalization
```typescript
import gender from '@matsukky/gender';
const result = gender('F', { capitalize: true });
console.log(result.genderName); // "Woman"
console.log(result.childTerm); // "Girl"
```
## API Reference
### gender(type, options)
```typescript
gender(type: AvalaibleGender, options?: {
capitalize?: boolean;
custom?: Record