# v-readmore

> A Vue.js read more component

Latest version **0.0.7** (published 2018-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install v-readmore
pnpm add v-readmore
yarn add v-readmore
bun add v-readmore
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2018-08-11 |
| First published | 2018-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 26.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | sinshutu |
| Maintainers | sinshutu |
| Keywords | vue, vue2, readmore, more, component |

## Links

- npm: https://www.npmjs.com/package/v-readmore
- Repository: https://github.com/sinshutu/v-readmore
- npm.io page: https://npm.io/package/v-readmore

## Recent versions

- 0.0.7 (latest) — 2018-08-11
- 0.0.6 — 2018-07-28
- 0.0.5 — 2018-07-28

## README

# v-readmore

The v-readmore component is a component for toggle the display according to the height.

## Demo

in preparation. (v-readmore/examples)

## Installation

```bash
$ npm install --save v-readmore
# or
$ yarn add v-readmore
```

## Usage

1. Import `VReadmore` and install it in Vue constructor.

  ```js
  import Vue from 'vue'
  import VReadmore from 'v-readmore'

  Vue.use(VReadmore)

  new Vue({
    // ...
  })
  ```

3. Use `<v-readmore>` component in your apps.

  ```vue
  <template>
    <v-readmore>
      <li v-for="i in 30" :key="i">item - {{ i }}</li>
    </v-readmore>
  </template>
  ```

### Auto installing v-readmore

If you have `Vue` constructor on `window`, you don't need to call `Vue.use(VReadmore)` since it will be called automatically. This is the case when you load Vue.js and v-readmore via `<script>` element.

## References

### `<v-readmore>` component

#### Props

* `collapsedHeight` - Number

  Optional - You can specify the height to enable readmore


#### Slots

* `(default)` - main content.

* `moreLink` - more button element.

* `lessLink` - less button element.

## License

MIT

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