# nz-custom-collapse

> A content area which can be collapsed and expanded, with some changes from the original ng-zorro collapse animation.

Latest version **0.0.6** (published 2019-05-16) · 0 weekly downloads

## Install

```sh
npm install nz-custom-collapse
pnpm add nz-custom-collapse
yarn add nz-custom-collapse
bun add nz-custom-collapse
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2019-05-16 |
| First published | 2019-05-13 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 182 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | midhunkrishnakv |

## Links

- npm: https://www.npmjs.com/package/nz-custom-collapse
- npm.io page: https://npm.io/package/nz-custom-collapse

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Recent versions

- 0.0.6 (latest) — 2019-05-16
- 0.0.5 — 2019-05-16
- 0.0.4 — 2019-05-16
- 0.0.2 — 2019-05-14
- 0.0.1 — 2019-05-13

## README

A content area which can be collapsed and expanded, with some changes from the original ng-zorro collapse animation.

## When To Use
- This package has dependency over `ng-zorro-antd module`. Install `ng-zorro-antd` package first in-order to use this package.
- Can be used to group or hide complex regions to keep the page clean.
- `Accordion` is a special kind of `Collapse`, which allows only one panel to be expanded at a time.


## Installation

**We recommend using `@angular/cli` to install**. It not only makes development easier, but also allows you to take advantage of the rich ecosystem of angular packages and tooling.

```bash
$ ng new PROJECT_NAME
$ cd PROJECT_NAME
$ ng add ng-zorro-antd
```
- `npm install nz-custom-collapse`. Append `@latest` tag inorder to get latest package version.

## Usage

Import the module into every module where you want to use the components.

```ts
import { NzCustomCollapseModule } from 'nz-custom-collapse';

@NgModule({
  imports: [ NzCustomCollapseModule ]
})
```

### nz-custom-collapse

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzAccordion]` | Accordion mode | `boolean` | `false`|
| `[nzBordered]` | Set border style | `boolean` | `true` |

### nz-custom-collapse-panel

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzDisabled]` | If `true`, panel cannot be opened or closed | `boolean` | `false` |
| `[nzHeader]` | Title of the panel | `string｜TemplateRef<void>` | - |
| `[nzExpandedIcon]` | Customize an icon for toggle | `string｜TemplateRef<void>` | - |
| `[nzExtra]` | Extra element in the corner | `string｜TemplateRef<void>` | - |
| `[nzShowArrow]` | Display arrow or not | `boolean` | `true` |
| `[nzActive]` | Active status of panel, double binding | `boolean` | - |
| `(nzActiveChange)` | Callback function of the active status | `EventEmitter<boolean>` | - |

---
_Source: https://npm.io/package/nz-custom-collapse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._