Skip to content

Commit ba7c77e

Browse files
sasidharansdsasidharansd
authored
docs: fix README typos and grammatical errors (#478)
Hey @santoshyadavdev , was reading through the README file, found few typo's hence dropped a pr to fix those. Lemme know if any changes needed.
1 parent 91b447f commit ba7c77e

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

‎README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Angular Universal carousel
1212

13-
`Note: This carousel doesn't include any css. go and customize css for buttons, items except ngucarousel and ngucarousel-inner`
13+
`Note: This carousel doesn't include any CSS. go and customize CSS for buttons, items except ngucarousel and ngucarousel-inner`
1414

1515
## Demo
1616

@@ -254,32 +254,32 @@ export type Animate = 'lazy';
254254

255255
| Command | Type | Required | Description |
256256
| ------------------------- | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
257-
| `grid` | Object | Yes | **xs** - mobile, **sm** - tablet, **md** - desktop, **lg** - large desktops, **xl** - extra large desktops, **all** - fixed width (When you use **all** make others 0 and vise versa) |
257+
| `grid` | Object | Yes | **xs** - mobile, **sm** - tablet, **md** - desktop, **lg** - large desktops, **xl** - extra large desktops, **all** - fixed width (When you use **all** make others 0 and vice versa) |
258258
| `gridBreakpoints` | Object | optional | Determines the browser width in pixels that the grid displays the intended number of tiles.<br/><br/> default: `{sm: 768, md: 992, lg: 1200, xl: 1200}` |
259259
| `slide` | number | optional | It is used to slide the number items on click |
260-
| `speed` | milli seconds | optional | It is used for time taken to slide the number items |
261-
| `interval` | milli seconds | optional | It is used to make carousel auto slide with given value. interval defines the interval between slides |
262-
| `load` | number | optional | is used to load the items similar to pagination. the carousel will tigger the carouslLoad function to load another set of items. it will help you to improve the performance of the app.**`(carouselLoad)="myfunc($event)"`** |
260+
| `speed` | milliseconds | optional | It is used for time taken to slide the number items |
261+
| `interval` | milliseconds | optional | It is used to make the carousel auto slide with given value. interval defines the interval between slides |
262+
| `load` | number | optional | It is used to load the items similar to pagination. The carousel will trigger the carouselLoad function to load another set of items. It will help you to improve the performance of the app.**`(carouselLoad)="myfunc($event)"`** |
263263
| `point.visible` | boolean | optional | It is used to indicate no. of slides and also shows the current active slide. |
264264
| `point.hideOnSingleSlide` | boolean | optional | It is used to hide the point indicator when slide is less than one. |
265265
| `touch` | boolean | optional | It is used to active touch support to the carousel. |
266266
| `easing` | string | optional | It is used to define the easing style of the carousel. Only define the ease name without any timing like `ease`,`ease-in` |
267267
| `loop` | boolean | optional | It is used to loop the `ngu-item ngu-tile`. It must be true for `interval` |
268-
| `animation` | string | optional | It is used to animate the sliding items. currently it only supports `lazy`. more coming soon and also with custom css animation option |
269-
| `custom` | string | optional | It is you to define the purpose of the carousel. currently it only supports `banner`. more coming soon and also with custom css animation option |
270-
| `RTL` | boolean | optional | This option enable the `rtl` direction and act as rtl. By default it is `ltr` |
268+
| `animation` | string | optional | It is used to animate the sliding items. currently it only supports `lazy`. more coming soon and also with custom CSS animation option |
269+
| `custom` | string | optional | It is you to define the purpose of the carousel. Currently, it only supports `banner`. |
270+
| `RTL` | boolean | optional | This option enables the `rtl` direction and acts as rtl. By default it is set to `ltr` |
271271
| `vertical.enabled` | boolean | optional | This option enable the `vertical` direction |
272-
| `vertical.height` | boolean | optional | This option is used to set the height of the carousel |
272+
| `vertical.height` | number | optional | This option is used to set the height of the carousel |
273273

274-
### Custom css for Point
274+
### Custom CSS for Point
275275

276276
```html
277277
<ul class="ngucarouselPoint">
278278
<li *ngFor="let i of pointNumbers; let i = index" [class.active]="i==pointers"></li>
279279
</ul>
280280
```
281281

282-
This is HTML I'm using in the carousel. Add your own css according to this elements in `pointStyles`. check below guide for more details.
282+
This is HTML I'm using in the carousel. Add your own CSS according to this elements in `pointStyles`. check below guide for more details.
283283

284284
```html
285285
<ngu-carousel [inputs]="carouselBanner" (onMove)="onmoveFn($event)" (carouselLoad)="loadItemsFn()">
@@ -602,8 +602,8 @@ export class Sample implements OnInit {
602602

603603
}
604604

605-
// carouselLoad will trigger this funnction when your load value reaches
606-
// it is helps to load the data by parts to increase the performance of the app
605+
// carouselLoad will trigger this function when your load value reaches
606+
// it helps to load the data by parts to increase the performance of the app
607607
// must use feature to all carousel
608608

609609
}
@@ -720,8 +720,8 @@ export class Sample implements OnInit {
720720

721721
}
722722

723-
// carouselLoad will trigger this funnction when your load value reaches
724-
// it is helps to load the data by parts to increase the performance of the app
723+
// carouselLoad will trigger this function when your load value reaches
724+
// it helps to load the data by parts to increase the performance of the app
725725
// must use feature to all carousel
726726

727727
}

‎libs/ngu/carousel/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Angular Universal carousel
44

5-
`Note: This carousel doesn't include any css. go and customize css for buttons, items except ngucarousel and ngucarousel-inner`
5+
`Note: This carousel doesn't include any CSS. go and customize CSS for buttons, items except ngucarousel and ngucarousel-inner`
66

77
## Demo
88

@@ -251,32 +251,32 @@ export type Animate = 'lazy';
251251

252252
| Command | Type | Required | Description |
253253
| ------------------------- | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
254-
| `grid` | Object | Yes | **xs** - mobile, **sm** - tablet, **md** - desktop, **lg** - large desktops, **xl** - extra large desktops, **all** - fixed width (When you use **all** make others 0 and vise versa) |
254+
| `grid` | Object | Yes | **xs** - mobile, **sm** - tablet, **md** - desktop, **lg** - large desktops, **xl** - extra large desktops, **all** - fixed width (When you use **all** make others 0 and vice versa) |
255255
| `gridBreakpoints` | Object | optional | Determines the browser width in pixels that the grid displays the intended number of tiles.<br/><br/> default: `{sm: 768, md: 992, lg: 1200, xl: 1200}` |
256256
| `slide` | number | optional | It is used to slide the number items on click |
257-
| `speed` | milli seconds | optional | It is used for time taken to slide the number items |
258-
| `interval` | milli seconds | optional | It is used to make carousel auto slide with given value. interval defines the interval between slides |
259-
| `load` | number | optional | is used to load the items similar to pagination. the carousel will tigger the carouslLoad function to load another set of items. it will help you to improve the performance of the app.**`(carouselLoad)="myfunc($event)"`** |
257+
| `speed` | milliseconds | optional | It is used for time taken to slide the number items |
258+
| `interval` | milliseconds | optional | It is used to make the carousel auto slide with given value. interval defines the interval between slides |
259+
| `load` | number | optional | It is used to load the items similar to pagination. The carousel will trigger the carouselLoad function to load another set of items. It will help you to improve the performance of the app.**`(carouselLoad)="myfunc($event)"`** |
260260
| `point.visible` | boolean | optional | It is used to indicate no. of slides and also shows the current active slide. |
261261
| `point.hideOnSingleSlide` | boolean | optional | It is used to hide the point indicator when slide is less than one. |
262262
| `touch` | boolean | optional | It is used to active touch support to the carousel. |
263263
| `easing` | string | optional | It is used to define the easing style of the carousel. Only define the ease name without any timing like `ease`,`ease-in` |
264264
| `loop` | boolean | optional | It is used to loop the `ngu-item | ngu-tile`. It must be true for `interval` |
265-
| `animation` | string | optional | It is used to animate the sliding items. currently it only supports `lazy`. more coming soon and also with custom css animation option |
266-
| `custom` | string | optional | It is you to define the purpose of the carousel. currently it only supports `banner`. more coming soon and also with custom css animation option |
267-
| `RTL` | boolean | optional | This option enable the `rtl` direction and act as rtl. By default it is `ltr` |
268-
| `vertical.enabled` | boolean | optional | This option enable the `vertical` direction |
269-
| `vertical.height` | boolean | optional | This option is used to set the height of the carousel |
265+
| `animation` | string | optional | It is used to animate the sliding items. currently it only supports `lazy`. more coming soon and also with custom CSS animation option |
266+
| `custom` | string | optional | It is you to define the purpose of the carousel. Currently, it only supports `banner`. |
267+
| `RTL` | boolean | optional | This option enables the `rtl` direction and acts as rtl. By default it is set to `ltr` |
268+
| `vertical.enabled` | boolean | optional | This option enables the `vertical` direction |
269+
| `vertical.height` | number | optional | This option is used to set the height of the carousel |
270270

271-
### Custom css for Point
271+
### Custom CSS for Point
272272

273273
```html
274274
<ul class="ngucarouselPoint">
275275
<li *ngFor="let i of pointNumbers; let i = index" [class.active]="i==pointers"></li>
276276
</ul>
277277
```
278278

279-
This is HTML I'm using in the carousel. Add your own css according to this elements in `pointStyles`. check below guide for more details.
279+
This is HTML I'm using in the carousel. Add your own CSS according to this elements in `pointStyles`. check below guide for more details.
280280

281281
```html
282282
<ngu-carousel [inputs]="carouselBanner" (onMove)="onmoveFn($event)" (carouselLoad)="loadItemsFn()">
@@ -592,8 +592,8 @@ export class Sample implements OnInit {
592592

593593
}
594594

595-
// carouselLoad will trigger this funnction when your load value reaches
596-
// it is helps to load the data by parts to increase the performance of the app
595+
// carouselLoad will trigger this function when your load value reaches
596+
// it helps to load the data by parts to increase the performance of the app
597597
// must use feature to all carousel
598598

599599
}
@@ -710,8 +710,8 @@ export class Sample implements OnInit {
710710

711711
}
712712

713-
// carouselLoad will trigger this funnction when your load value reaches
714-
// it is helps to load the data by parts to increase the performance of the app
713+
// carouselLoad will trigger this function when your load value reaches
714+
// it helps to load the data by parts to increase the performance of the app
715715
// must use feature to all carousel
716716

717717
}

0 commit comments

Comments
 (0)