# vue-read-more-smooth

> "Read more" button with animation and easy usage for vuejs.

Latest version **0.1.8** (published 2019-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-read-more-smooth
pnpm add vue-read-more-smooth
yarn add vue-read-more-smooth
bun add vue-read-more-smooth
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2019-08-09 |
| First published | 2019-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 578.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Dicren |
| Maintainers | dicren |
| Keywords | vue, vuejs, plugin, read more |

## Links

- npm: https://www.npmjs.com/package/vue-read-more-smooth
- Repository: https://github.com/DiCrEn/vue-read-more-smooth
- Homepage: https://dicren.github.io/vue-read-more-smooth/
- Issues: https://github.com/DiCrEn/vue-read-more-smooth/issues
- npm.io page: https://npm.io/package/vue-read-more-smooth

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^2.6.10

## Recent versions

- 0.1.8 (latest) — 2019-08-09
- 0.1.7 — 2019-08-09
- 0.1.6 — 2019-07-03
- 0.1.5 — 2019-06-24
- 0.1.4 — 2019-06-24
- 0.1.3 — 2019-06-24
- 0.1.2 — 2019-06-23
- 0.1.1 — 2019-06-23
- 0.1.0 — 2019-06-23

## README

# vue-read-more-smooth

[![license](https://img.shields.io/github/license/dicren/vue-read-more-smooth.svg?style=flat-square)](./LICENSE)
[![vue 2](https://img.shields.io/badge/vue-2-42b983.svg?style=flat-square)](https://vuejs.org)
[![npm](https://img.shields.io/npm/v/vue-read-more-smooth.svg?style=flat-square)](https://www.npmjs.com/package/vue-read-more-smooth)
[![npm](https://img.shields.io/npm/dt/vue-read-more-smooth.svg?style=flat-square)](https://www.npmjs.com/package/vue-read-more-smooth)



"Read more" button with animation and easy usage for vuejs.

## Install

Via [npm](https://www.npmjs.com/):

[![npm](https://nodei.co/npm/vue-read-more-smooth.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/vue-read-more-smooth)

```🚀sh
npm install vue-read-more-smooth --save
```
Via [Yarn](https://yarnpkg.com/):

```sh
yarn add vue-read-more-smooth
```

## Demo & examples

![](demo.gif)

Code examples: https://dicren.github.io/vue-read-more-smooth/

## Usage

```jsx
<template>
  <VueReadMoreSmooth>
    <p>Lorem Ipsum</p>
  </VueReadMoreSmooth>
</template>
<script>
  import VueReadMoreSmooth from "vue-read-more-smooth";
  export default {
    name: "app",
    components: { VueReadMoreSmooth }
  }
</script>
```

## Properties

 |  Property  |  Type  |  Default  |  Description  | 
 |  -  |  :-:  |  :-:  |  -  | 
 |  :lines  | number | `3`  |  Number of lines to show before the read more button. | 
 |  :g-lines | number | `2` |  Shadow's size. If lines is greater than 12, g-lines default value is 4, if lines is greater than 6, g-lines default value is 3
 |  :max-lines | number | `lines + 1` |  If your text has less than max-lines, the container acts as a normal div.
 |  :text | string | `Read more` |  obvious
 |  :text-less | string | `Read less` |  obvious
 |  :no-less | boolean | `false` |  if true button disappear after click read more
 |  :open | boolean | `false` |  open and close programmatically. .sync is available.
 |  :no-button | boolean | `false` |  Hide the button. To use in combination with :open
 |  :no-shadow | boolean | `false` |  Hide the shadow.
 

## Changelog

### 0.1.8 - 2019-08-09
#### Added
- :open property
- :no-button property
- :no-shadow property
#### Removed
- :open-by-default property, replaced by :open

## License

[MIT](LICENSE)

---
⌨️ with ❤️ by [dicren](https://github.com/dicren)

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