# Permission matrix

> Roles against actions, used and unused. Sample data: admin, editor, viewer and a draft role across seven actions, from pausing agents to viewing billing.

- Type 127 · Relationship
- Component: `<PermissionMatrix>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/permission-matrix` (Code and Complete plans)
- Type page: https://usechartory.com/charts/permission-matrix

## Installation

1. **Set up the registry once.** Your token in .env and @chartory in components.json. Skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Permission matrix component to your project.

```bash
npx shadcn add @chartory/permission-matrix
```

3. **Use it.** Pass your rows. The props are the Figma properties.

usage.tsx:

```tsx
import { PermissionMatrix }
  from "@/components/chartory/permission-matrix"

<PermissionMatrix
  data={roleGrants}
  size="m"
  legend
/>
```

## Props

### `<PermissionMatrix>`

Every prop but data is a Figma property with the same name and values.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | PermissionMatrixData | Required | The chart's data. The tables below list every field. |
| size | "xs" \| "s" \| "m" \| "l" | "m" | The size class. Each one is laid out again from the data. |
| legend | boolean | true | Shows the legend row under the plot. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### PermissionMatrixData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| roles | PermissionMatrixRole[] | Required | One entry per role. |
| rows | PermissionMatrixRow[] | Required | One entry per row. |

### PermissionMatrixRole

One object per entry in roles.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| draft? | boolean | false | Marks it as a draft. |

### PermissionMatrixRow

One object per entry in rows.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| label | string | Required | The name shown on the chart. |
| cells | string | Required | One character per role, in role order. |

## Permission matrix: a React and Figma chart in four sizes

### What does a permission matrix show?

A permission matrix crosses roles with actions and marks each grant as used, unused, added or removed in a draft. Grants nobody uses stand out. Use it for role reviews and least-privilege clean-ups.

Chartory ships it as a Figma component and a React component with the same name. The code installs from the shadcn registry with one command and lands in your project as a file you own.

### What is the Permission matrix component?

It is one **<PermissionMatrix>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is a grant state per role and action.

Sizes **XS**, **S**, **M** and **L** re-lay the chart out from the data instead of scaling it, so labels stay readable at every size.

### When should I use it?

- **Are several roles compared?** Yes means the permission matrix fits.
- **Are grants yes or no?** Yes means the permission matrix fits.
- **Is it access, not ownership?** Yes means the permission matrix fits.

### When does another type fit better?

- **One key's reach.** Use Reach tree instead.
- **Counts per cell.** Use Cells matrix instead.
- **Owners and health.** Use Ownership matrix instead.

## Permission matrix questions

### Does the Permission matrix chart work with shadcn/ui?

Yes. It installs through the shadcn registry with the shadcn CLI, and the file lands in your project.

### How do I install it?

Add your token and the @chartory registry once, then run npx shadcn add @chartory/permission-matrix. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the permission matrix chart; the agent runs the same command and you review the diff.

### What data does it expect?

A grant state per role and action. The sample data comes with the component, and the props table lists every field.

### Which sizes does it ship in?

XS, S, M and L, in Figma and in code. Each size is laid out again from the data, so text and lines keep their size.

### Is it in the Figma file too?

Yes. chart/127-permission-matrix has the same properties as the component.

### Does it follow light and dark mode?

Yes. Every paint is a token, so the chart follows light and dark mode and the collection you pick.

### Which plan has the code?

Code and Complete. Figma has the Figma file only.