# @kong-ui-public/entities-consumer-groups

Consumer Groups entity components.

- [Requirements](#requirements)
- [Included components](#included-components)
- [Usage](#usage)
  - [Install](#install)
  - [Registration](#registration)
- [Individual component documentation](#individual-component-documentation)

## Requirements

Check the [individual component docs](#individual-component-documentation) for more info.

## Included components

- `ConsumerGroupList`
- `ConsumerGroupForm`
- `ConsumerGroupConfigCard`

Reference the [individual component docs](#individual-component-documentation) for more info.

## Usage

### Install

Install the component in your host application

```sh
yarn add @kong-ui-public/entities-consumer-groups
```

### Registration

Import the component(s) in your host application as well as the package styles

```ts
import { ConsumerGroupList, ConsumerGroupForm } from '@kong-ui-public/entities-consumer-groups'
import '@kong-ui-public/entities-consumer-groups/dist/style.css'
```

## Individual component documentation

- [`<ConsumerGroupList.vue />`](docs/consumer-group-list.md)
- [`<ConsumerGroupForm.vue />`](docs/consumer-group-form.md)
- [`<ConsumerGroupConfigCard.vue />`](docs/consumer-group-config-card.md)