@nexo-labs/payload-taxonomies/README.md

Taxonomies for Payload CMS

# @nexo-labs/payload-taxonomies

Hierarchical taxonomy collection and relationship utilities for Payload CMS.

## Installation

```bash
pnpm add @nexo-labs/payload-taxonomies
```

## Usage

```ts
// payload.config.ts
import { taxonomiesCollection } from '@nexo-labs/payload-taxonomies'

export default buildConfig({
  collections: [
    taxonomiesCollection(),
    // your other collections...
  ],
})
```

```ts
// In another collection
import { buildTaxonomyRelationship } from '@nexo-labs/payload-taxonomies'

const PostsCollection = {
  slug: 'posts',
  fields: [
    buildTaxonomyRelationship({ hasMany: true }),
    // other fields...
  ],
}
```

## Exports

### Main (`.`)

- **`taxonomiesCollection`** - Pre-configured taxonomy collection builder
- **`buildTaxonomyRelationship`** - Helper to create taxonomy relationship fields
- **`COLLECTION_SLUG_TAXONOMY`** - Collection slug constant

### Constants (`./constants`)

- **`COLLECTION_SLUG_TAXONOMY`** - Lightweight import for the slug constant only

## Features

- Pre-built hierarchical taxonomy collection with slug generation
- Localized taxonomy names
- Custom JSON payload field for metadata
- Relationship helper for integrating taxonomies into other collections
- Optional TypeScript schema for typed JSON payloads

## Peer Dependencies

- `payload` ^3.75.0
- `@payloadcms/ui` ^3.75.0
- `react` ^19.0.0

## License

MIT