# fr-carousel

> Fr-Carousel is a friendly angular carousel component and it supports swipe feature for touch devices.

Latest version **1.2.1** (published 2020-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install fr-carousel
pnpm add fr-carousel
yarn add fr-carousel
bun add fr-carousel
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-05-04 |
| First published | 2020-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 444.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Huynh Long Hai |
| Maintainers | longhaine |
| Keywords | angular, carousel, swiper, slider |

## Links

- npm: https://www.npmjs.com/package/fr-carousel
- Repository: https://github.com/longhaine/fr-carousel
- Homepage: https://github.com/longhaine/fr-carousel#readme
- Issues: https://github.com/longhaine/fr-carousel/issues
- npm.io page: https://npm.io/package/fr-carousel

## Dependencies (1)

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

## Alternatives

- [adhdev](https://npm.io/package/adhdev.md) — 11.1K weekly downloads
- [react-slide-button](https://npm.io/package/react-slide-button.md) — 310 weekly downloads
- [better](https://npm.io/package/better.md) — 42 weekly downloads
- [react-native-swipe-image](https://npm.io/package/react-native-swipe-image.md) — 22 weekly downloads
- [nl.fokkezb.pulltorefresh](https://npm.io/package/nl.fokkezb.pulltorefresh.md) — 11 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2020-05-04
- 1.2.0 — 2020-05-03
- 1.1.2 — 2020-04-29
- 1.1.1 — 2020-04-22
- 1.1.0 — 2020-04-21
- 1.0.0 — 2020-04-15

## README

# Fr-Carousel

Fr-Carousel is a friendly angular carousel component and it supports swipe feature for touch devices.

## Demo

https://longhaine.github.io/fr-demos/fr-carousel

## Installation

```
npm install fr-carousel --save
```
Once installed you need to import the module:
```
import  {FrCarouselModule}  from  'fr-carousel';

@NgModule({

 ...

 imports:  [FrCarouselModule,  ...],

 ...

})

export class  AppModule  {

}
```
## Usage

```
<fr-carousel>
	<ng-template FrSlide>
		...
	</ng-template>
	<ng-template FrSlide>
		...
	</ng-template>
	<ng-template FrSlide>
		...
	</ng-template>
</fr-carousel>
```
## FrCarousel
#### selector: `fr-carousel`
### Inputs

| Input | Type | Default |Description|
| :---         |     :---:      |  :--- |:---
| `showNavigationArrows` |`boolean` | `true` |if `true`, 'previous' and 'next' navigation arrows will be visible on the slide.
| `showNavigationIndicators` | `boolean` |`true`|If `true`, navigation indicators at the bottom of the slide will be visible.   |
|`keyboard`|`boolean`|`true`|If `true`, allows to interact with carousel using keyboard 'arrow left' and 'arrow right'.
|`interval`|`number`|`5000`|Time in milliseconds before the next slide is shown.|
|`animationDuration`|`number`|`500`|Time in milliseconds of sliding animation.|
|`pauseOnHover`|`boolean`|`true`|If `true`, will pause slide switching when mouse cursor hovers the slide.|
### Methods
| Method| Description|
| :---         |:---
|` prev` |`prev()`  => void <br/>Navigates to the previous slide.
| `next` |`next()`  => void <br/>Navigates to the next slide.
| `pause` |`pause()`  => void <br/>Pauses cycling through the slides.
| `cycle` |`cycle()`  => void <br/>Restarts cycling through the slides from left to right.

## FrSlide
### selector: `ng-template[FrSlide]`
### Inputs

| Input | Type | Description|
| :---  |     :---:  |  :--- 
| `id` |`string` |Slide id that must be unique for the entire document.<br/>If not provided, will be generated in the  `fr-slide-x`  format.

## FrCarouselConfig

A configuration service for the FrCarousel component.

You can inject this service, typically in your root component, and customize its properties to provide default values for all carousels used in the application.

`interval` `animationDuration` `keyboard` `pauseOnHover` `showNavigationArrows` `showNavigationIndicators`

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