Forms for
every human.

Quickstart

Install once, import only what you need. Every module ships as a subpath export, so unused locales and modules are removed by tree-shaking.

# pick your package manager — all fully supported
npm  install inclusive-kit
pnpm add     inclusive-kit
yarn add     inclusive-kit
bun  add     inclusive-kit

import { genderField } from "inclusive-kit/fields";
import { analyze, rewrite } from "inclusive-kit/text";
import { auditForm } from "inclusive-kit/audit";
import { listIdentities, flagSvg } from "inclusive-kit/registry";

// One call → a fully inclusive gender field with a11y metadata
const field = genderField({ locale: "en", allowSelfDescribe: true });

Modules

Use cases

Where teams plug inclusive-kit in — from a single signup form to organization-wide content review.

Identities

A structured catalog of gender identities — each with localized name and description, category, pronoun hints, and pride flag data. Cultural identities are opt-in: they carry deep cultural context and don't belong in generic dropdowns.

import { listIdentities, searchIdentities } from "inclusive-kit/registry";

listIdentities({ locale: "es" });                       // 28 non-cultural
listIdentities({ locale: "es", includeCultural: true }); // all 35
searchIdentities("she/her", { locale: "en" });          // match id, alias, pronouns

Pride flags

Flags are generated from stripe color arrays — as inline SVG or a CSS gradient. Zero image assets, crisp at any size, with accessible <title> baked in.

import { flagSvg, flagCss } from "inclusive-kit/registry";

flagSvg("non-binary", { width: 200, rounded: true }); // → "<svg …>"
flagCss("transgender"); // → "linear-gradient(180deg, #55CDFC 0%…)"

Pronoun sets

Eleven fully-declined pronoun sets — 8 English (including ze, xe, fae, ey neopronouns) and 3 Spanish (elle, ella, él). Each carries subject, object, both possessives, reflexive, and a plural-verb flag. conjugate() turns pronoun-safe templates into correct sentences for emails and personalized UI.

import { getPronounSet, conjugate, formatPronounSet } from "inclusive-kit/pronouns";

const ze = getPronounSet("ze");
conjugate("{Subject} took {possessiveDeterminer} keys.", ze);
// → "Ze took zir keys."

formatPronounSet(ze);          // "ze/zem"
formatPronounSet(ze, "full");  // "ze/zem/zir/zirs/zirself"

genderField()

One factory, three modes. Every result includes prefer-not-to-say by design, is never required, and carries a why string explaining the inclusive design decision to the integrating developer.

genderField({ locale: "es", mode: "extended", allowSelfDescribe: true });

Validators

Validators that reject genuinely invalid input — not valid humans. Unicode names, mononyms, compound names, no upper age caps.

import { validatePersonName, validateBirthDate } from "inclusive-kit/validate";

validatePersonName("María-José O'Neill 陳"); // { valid: true }
validatePersonName("X");                     // mononyms are valid
validateBirthDate("1930-01-01");             // { valid: true, age: 96 }

analyze()

Scans text against 75 English and 55 Spanish rules across four categories — gender, disability, age, ethnicity. Word-boundary matched, case-insensitive, with constructive suggestions on every finding.

import { analyze } from "inclusive-kit/text";

const { findings } = analyze(text, { locale: "en" });
// findings: [{ term, matched, index, category, severity, suggestions, note }]

Custom rules

Bring your company glossary. Custom rules merge with the built-in locale pack, support any category string, and ignoreTerms silences rules you disagree with — built-in or custom.

import { analyze, defineRule } from "inclusive-kit/text";

const brandRules = [
  defineRule({
    term: "blacklist",
    category: "brand-glossary",   // any string works
    severity: "high",
    suggestions: ["blocklist", "denylist"],
  }),
];

analyze(text, {
  locale: "en",
  customRules: brandRules,        // merged with built-ins
  ignoreTerms: ["guys"],          // silence any rule, case-insensitive
});
// rewrite() accepts the same options

Try it in the analyze() demo above — the "Custom rules" and "Ignore terms" inputs feed straight into the engine.

rewrite()

Goes one step further than analyze: applies the first suggestion for every finding, preserving case (Mankind → Humankind, MANPOWER → WORKFORCE) and processing right-to-left so indices never shift.

const { text, changes } = rewrite(input, { locale: "en" });
// changes: [{ original, replacement, index, category, severity }]

auditForm()

Feed it your form definition, get a 0–100 inclusivity score plus actionable issues. Detects binary-only gender, name splits, required sensitive fields, forced honorifics, and non-inclusive label language. Wire it into CI.

const { score, issues } = auditForm({
  fields: [
    { id: "gender", type: "select", options: ["Male", "Female"], required: true },
  ],
});
// score: 40 · issues: [binary-gender, missing-pnts, required-gender]

Penalties: high −25 · medium −10 · low −5 · info −2.