Skip to content

Commit

Permalink
docs: fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
daybrush committed Feb 22, 2022
1 parent acba2d1 commit 0721a3b
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 45 deletions.
4 changes: 2 additions & 2 deletions packages/ngx-conveyer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export class AppModule { } /* Your app */

```html
<div class="container">
<button id="prev" (click)="prev()">prev</button>
<button id="next" (click)="next()">next</button>
<button id="prev" [disabled]="conveyer?.isReachStart" (click)="prev()">prev</button>
<button id="next" [disabled]="conveyer?.isReachEnd" (click)="next()">next</button>
<div class="items" NgxConveyer #conveyer="ngxConveyer">
<div class="item">1</div>
<div class="item">2</div>
Expand Down
141 changes: 100 additions & 41 deletions packages/ngx-conveyer/projects/ngx-conveyer/README.md
Original file line number Diff line number Diff line change
@@ -1,80 +1,139 @@
## ngx-conveyer
<h1 align="center" style="max-width: 100%;">
<img width="256" alt="Conveyer Logo" src="https://naver.github.io/egjs-conveyer/img/logo.png" style="max-width: 100%;" /><br/>
<a href="https://naver.github.io/egjs-conveyer/">Angular Conveyer</a>
</h1>

```sh
$ npm i ngx-conveyer
```
<p align="center" style="line-height: 2;">
<a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img src="https://img.shields.io/npm/v/@egjs/conveyer.svg?style=flat-square&color=007acc&label=version&logo=NPM" alt="version" /></a>
<a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img alt="npm weekly downloads" src="https://img.shields.io/npm/dw/@egjs/conveyer?logo=npm&style=flat-square&color=007acc" /></a>
<a href="https://www.npmjs.com/package/@egjs/ngx-conveyer" target="_blank"><img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@egjs/ngx-conveyer.svg?style=flat-square&label=%F0%9F%92%BE%20gzipped&color=007acc" /></a>
<a href="https://github.com/naver/egjs-conveyer/actions" target="_blank"><img alt="Github actions" src="https://img.shields.io/github/workflow/status/naver/egjs-conveyer/Run%20tests?style=flat-square" /></a>
<a href="https://coveralls.io/github/naver/egjs-conveyer?branch=master&style=flat-square" target="_blank"><img alt="Coveralls github" src="https://img.shields.io/coveralls/github/naver/egjs-conveyer.svg?style=flat-square&label=%E2%9C%85%20coverage" /></a>
<a href="https://github.com/naver/egjs-conveyer/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?style=flat-square&label=%F0%9F%93%9C%20license&message=MIT&color=08CE5D" /></a>
<img src="https://img.shields.io/static/v1.svg?label=&message=TypeScript&color=294E80&style=flat-square&logo=typescript" />
</p>
<h3 align="center">
<a href="https://naver.github.io/egjs-conveyer/">Demo</a> / <a href="https://naver.github.io/egjs-conveyer/docs/api/Conveyer">Documentation</a> / <a href="https://naver.github.io/egjs/"><img height="20" src="https://naver.github.io/egjs/img/logo.svg"/> Other components</a>
</h3>

### use reference variable with reactive state
```
#refName="ngxConveyer"
<p align="center">
<b>Conveyer adds Drag gestures to your Native Scroll.</b><br />📱💻🖥
</p>


-----

## ✨ Features
- You can use Native Scroll-like behavior through Drag.
- By adding easing features such as bounce, elasticity, and back, you can create smooth scrolling animations like Native Scroll.
- Supports Reactive Properties that can detect changes, such as isReachStart, isReachEnd.
- You can use custom scroll events like onBeginScroll, onFinishScroll, onReachStart, onLeaveStart,

## ⚙️ Installation

```bash
$ npm install @egjs/ngx-conveyer
```
* refName.isReachStart
* refName.isReachEnd

```js
import { NgModule } from '@angular/core';
## 🏃 Quick Start
### Module definition
```diff
+import { NgxConveyerModule } from '@egjs/ngx-conveyer';
import { BrowserModule } from '@angular/platform-browser';
import { NgxConveyerModule } from 'ngx-conveyer';

import { AppComponent } from './app.component';
import { NgModule } from '@angular/core';

@NgModule({
declarations: [
AppComponent,
AppComponent
],
imports: [
BrowserModule,
NgxConveyerModule,
+ NgxConveyerModule /* Add in imports */
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
export class AppModule { } /* Your app */
```

```html
<div class="App">
<button id="prev" [disabled]="conveyer?.isReachStart" (click)="prev()">PREV</button>
<button id="next" [disabled]="conveyer?.isReachEnd" (click)="next()">NEXT</button>
<div class="items" [ngxConveyer]="{ horizontal: false, preventClickOnDrag: false }" #conveyer="ngxConveyer">
<div class="item"><a href="#1">1</a></div>
<div class="item"><a href="#2">2</a></div>
<div class="item"><a href="#3">3</a></div>
<div class="item"><a href="#4">4</a></div>
<div class="item"><a href="#5">5</a></div>
<div class="item"><a href="#6">6</a></div>
<div class="item"><a href="#7">7</a></div>
<div class="item"><a href="#8">8</a></div>
<div class="item"><a href="#9">9</a></div>
<div class="item"><a href="#10">10</a></div>
<div class="item"><a href="#11">11</a></div>
<div class="item"><a href="#12">12</a></div>
<div class="container">
<button id="prev" [disabled]="conveyer?.isReachStart" (click)="prev()">prev</button>
<button id="next" [disabled]="conveyer?.isReachEnd" (click)="next()">next</button>
<div class="items" NgxConveyer #conveyer="ngxConveyer">
<div class="item">1</div>
<div class="item">2</div>
<div class="item">3</div>
</div>
</div>
```

```ts
import { Component, ViewChild } from '@angular/core';
import { NgxConveyerDirective } from 'ngx-conveyer';
import { Component, Input, AfterViewInit } from '@angular/core';
import { NgxConveyerComponent } from '@egjs/ngx-conveyer';

@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
@ViewChild("conveyer") cv!: NgxConveyerDirective;
title = 'ngx-conveyer-project';
export class AppComponent implements AfterViewInit {
@ViewChild("conveyer") conveyer!: NgxConveyerComponent;
prev() {
this.cv.scrollIntoView("prev", {
this.conveyer.scrollIntoView("prev", {
align: "end",
duration: 500,
});
}
next() {
this.cv.scrollIntoView("next", {
this.conveyer.scrollIntoView("next", {
align: "start",
duration: 500,
});
}
}
```


## 🌐 Supported Browsers
|<img width="20" src="https://simpleicons.org/icons/internetexplorer.svg" alt="IE" />|<img width="20" src="https://simpleicons.org/icons/googlechrome.svg" alt="Chrome" />|<img width="20" src="https://simpleicons.org/icons/firefoxbrowser.svg" alt="Firefox" />|<img width="20" src="https://simpleicons.org/icons/safari.svg" alt="Safari" />|<img width="20" src="https://simpleicons.org/icons/apple.svg" alt="iOS" />|<img width="20" src="https://simpleicons.org/icons/android.svg" alt="Android" />|
|:---:|:---:|:---:|:---:|:---:|:---:|
|9+(With polyfill), 11+ for Angular & Svelte|Latest|Latest|Latest|7+|4+|

## 📼 Demos
Check our [Demos](https://naver.github.io/egjs-conveyer/).

## 📖 Documentation
See [Documentation](https://naver.github.io/egjs-conveyer/release/latest/doc/index.html) page.

## 🙌 Contributing
See [CONTRIBUTING.md](https://github.com/naver/egjs-conveyer/blob/main/CONTRIBUTING.md).

## 📝 Feedback
Please file an [Issue](https://github.com/naver/egjs-conveyer/issues).


## 📜 License
@egjs/ngx-conveyer is released under the [MIT license](https://github.com/naver/egjs-conveyer/blob/main/LICENSE).

```
Copyright (c) 2022-present NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```

<p align="center">
<a href="https://naver.github.io/egjs/"><img height="50" src="https://naver.github.io/egjs/img/logotype1_black.svg" /></a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/naver"><img height="50" src="https://naver.github.io/OpenSourceGuide/book/assets/naver_logo.png" /></a>
</p>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/ngx-conveyer/projects/ngx-conveyer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@egjs/ngx-conveyer",
"version": "1.0.0",
"version": "1.0.1",
"description": "Angular Conveyer adds Drag gestures to your Native Scroll.",
"author": {
"name": "NAVER Corp."
Expand Down

0 comments on commit 0721a3b

Please sign in to comment.