https://github.com/reyesoft/ngx-carousel

https://github.com/reyesoft/ngx-carousel

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/reyesoft/ngx-carousel
• Owner: reyesoft
• Created: 2021-02-03T18:09:38.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-25T18:42:26.000Z (almost 4 years ago)
• Last Synced: 2024-11-24T20:55:19.297Z (about 2 months ago)
• Language: TypeScript
• Size: 490 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NgxCarousel

A simple library for creating carousel for Angular

## Get started

1. Run ```bash yarn add ngx-carousel ``` or ```bash npm install ngx-carousel ```

2. Import NgxCarouselModule into module a module which declares a component intended to have a carousel

```

import { NgxCarouselModule } from 'ngx-carousel';

@NgModule({

  imports: [ NgxCarouselModule ]

})

export class ExampleModule { }

```

3. Usage

```

    
Slide 1

    
Slide 2

    
Slide 3

    
Slide 4

    
Slide 5


```

## Local demo app

```bash

git clone https://github.com/reyesoft/ngx-carousel.git

cd ngx-carousel

yarn

yarn start

```

## Build

Run `yarn build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Publishing

After building your library with `ng build ngx-carousel`, go to the dist folder `cd dist/ngx-carousel` and run `npm publish`.