# Enum Plus

> Use when defining, migrating, validating, localizing, or rendering enum-plus enums in TypeScript or JavaScript code, including replacing native enums, adding labels or metadata, generating UI option data, installing enum-plus plugins, or narrowing values with enum-derived types.

- Skill: `antdv-next/enum-plus` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add antdv-next/enum-plus`
- Raw SKILL.md: https://api.skillmd.com/api/skills/antdv-next/enum-plus/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: antdv-next (https://skillmd.com/u/antdv-next)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/antdv-next/enum-plus

---


# Enum Plus

## Overview

Use `Enum(...)` when plain constants or native `enum` are not enough and the task needs labels, metadata, option lists, reverse lookup, or enum-aware typing. Prefer the standard object form in application code because it keeps UI text, metadata, and lookups in one place.

## Workflow

1. Pick one enum shape and keep it consistent for the whole enum.
2. Prefer the standard `{ value, label, ...meta }` form unless the task is intentionally simpler.
3. Use built-in enum methods before writing custom maps or switch statements.
4. Read the matching reference file for deeper details.

## Choose the Input Form

- Use key-value form for lightweight constant replacement.
- Use standard form for most app code, especially if the enum feeds UI or needs metadata.
- Use key-label form when `value` should equal `key`.
- Use array form when the source data is dynamic or comes from an API.
- Use native-enum conversion only when the project already owns a native `enum` and wants enum-plus behavior on top.

Read [`references/core-api.md`](./references/core-api.md) for examples of each form.

## Apply the Core Rules

- Do not mix initialization shapes inside one enum.
- Keep enum type names in `PascalCase` with an `Enum` suffix.
- Prefer enum member keys in `PascalCase`.
- Use `has`, `label`, `key`, `findBy`, `toList`, and `toMap` before writing custom helpers.
- Store UI-adjacent metadata on enum items instead of scattering extra lookup tables.
- Validate untrusted values with `enum.has(value)` before consuming them.

## TypeScript Guidance

- If the codebase uses TypeScript below 5.0, add `as const` to preserve literal values.
- Use `typeof MyEnum.valueType` for value unions and `typeof MyEnum.keyType` for key unions.
- Use `typeof MyEnum.rawType` when another API needs the initializer shape.
- When adding global extensions, also add the matching `declare module 'enum-plus/extension'` typing.

## UI and Localization Guidance

- For component option lists, prefer `enum.items` first.
- Use `toList` or `toMap` only when the consumer expects custom field names or a different shape.
- `@enum-plus/plugin-antd` is already installed globally in `src/main.ts` via `Enum.install(antdPlugins)`. Methods like `toSelect`, `toMenu`, `toFilter`, and `toValueMap` are available on all enums — no extra setup needed.
- This project currently uses direct string labels (e.g. Chinese text) rather than i18n keys. `Enum.localize` is not wired and no i18n plugin is installed. Do not assume labels are localized.
- If the task also changes Vue, antdv-next, or repo-specific UI code, load the matching repo skill alongside this one.

Read [`references/integration-patterns.md`](./references/integration-patterns.md) for concrete integration patterns.

## Common Moves

- Replace `switch`-based label lookup with `enum.label(value)`.
- Replace separate `options` arrays with `enum.items` or `enum.toList(...)`.
- Replace ad hoc reverse maps with `enum.key(value)` or `enum.findBy(...)`.
- Replace duplicated metadata tables with enum item `raw` fields.
- Convert an existing native `enum` with `Enum(NativeEnum)` when incremental migration is safer than a rewrite.

## References

- [`references/core-api.md`](./references/core-api.md): initializer formats, instance API, static API, config, and TS-only types.
- [`references/integration-patterns.md`](./references/integration-patterns.md): UI binding, plugin usage, localization, conflicts, and best practices.

## Constraints

- Do not claim plugin methods exist unless the plugin was installed.
- Do not assume `label` is localized unless `Enum.localize` or an i18n plugin is configured.
- Do not hand-roll mutable edits against `enum.items`; treat enum collections as read-only.