Skip to content

Commit 039ca6d

Browse files
committed
chore(readme): update readme docs
1 parent 821e5e1 commit 039ca6d

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

projects/igniteui-angular/src/lib/badge/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A walkthrough of how to get started can be found [here](https://www.infragistics
1313
| Name | Type | Description |
1414
|:----------|:-------------:|:------|
1515
| `id` | string | Unique identifier of the component. If not provided it will be automatically generated.|
16-
| `type` | string | Set the type of the badge to either `default`, `info`, `success`, `warning`, or `error`. This will change the background color of the badge according to the values set in the default theme. |
16+
| `type` | string | Set the type of the badge to either `info`, `success`, `warning`, or `error`. This will change the background color of the badge according to the values set in the default theme. |
1717
| `position` | string | Set the position of the badge relative to its parent container to either `top-right`, `top-left`, `bottom-right`, or `bottom-left`. |
1818
| `value` | string | Set the value to be displayed inside the badge. |
1919
| `icon` | string | Set an icon for the badge from the material icons set. Will not be displayed if `value` for the badge is already set. |

projects/igniteui-angular/src/lib/card/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Supporting directives and components:
3939
| Name | Type | Description |
4040
|:----------|:-------------:|:------|
4141
| `id` | string | Unique identifier of the component. If not provided it will be automatically generated.|
42-
| `type` | IgxCardType | The type of the card component. It can be either `default` or `outlined`. |
42+
| `type` | IgxCardType | The type of the card component. It can be either `elevated` or `outlined`. |
4343
| `role` | string | The role attribute of the card. By default it's set to `group`. |
4444
| `isCardOutlined` | boolean | Returns `true` if the card is outlined. |
4545
| `horizontal`* | boolean | Sets the card layout direction. When set to `true` the card content is horizontally layed out. |
@@ -60,7 +60,7 @@ Supporting directives and components:
6060
## igx-card-actions
6161
| Name | Type | Description |
6262
|:----------|:-------------:|:------|
63-
| `layout` | IgxCardActionsLayout | Sets the layout type of the area. Can be either `default` or `justify`. |
63+
| `layout` | IgxCardActionsLayout | Sets the layout type of the area. Can be either `left` or `justify`. |
6464
| `vertical` | boolean | Sets the layout direction. When set to `true` all buttons in the area will be aligned vertically. |
6565
| `reverse` | boolean | Reverses the layout of the area. When set to `true` all `igx-icons` and/or `igx-button='icon` will appear before all regular(text) buttons. |
6666
| `isJustifyLayout` | boolean | Returns true when the layout type is set to `justify`. |

projects/igniteui-angular/src/lib/directives/divider/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The **igx-divider** is a directive that groups content in lists and layout.
3737
|:----------|:-------------:|:------|
3838
| `id` | string | Unique identifier of the component. If not provided it will be automatically generated.|
3939
| `role` | string | The role attribute of the divider. By default it's set to `separator`. |
40-
| `type` | IgxDividerType | The type of the divider. Can be `default` or `dashed`. |
40+
| `type` | IgxDividerType | The type of the divider. Can be `solid` or `dashed`. |
4141
| `inset` | string | The space between the separator and the surrounding container. Provide the value in `px`, `%`, or relative units(`em`, `rem`). |
4242
| `middle` | boolean | When set to `true`, the divider will be set in on both sides when an `inset` value is provided. |
4343
| `vertical` | boolean | Whether the divider should be vertically layed out. |

projects/igniteui-angular/src/lib/progressbar/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export class AppModule {}
3535
|:----------|:-------------:|:------|
3636
| `id` | string | Unique identifier of the component. If not provided it will be automatically generated.|
3737
| `max` | number | Set maximum value that can be passed. By default it is set to 100. |
38-
| `type` | string | Set type of the linear bar. Possible options - `default`, `success`, `info`, `warning`, and `danger`. |
38+
| `type` | string | Set type of the linear bar. Possible options - `success`, `info`, `warning`, and `error`. |
3939
| `value` | number | Set value that indicates the completed bar position. |
4040
| `striped` | boolean | Set bar to have striped style. |
4141
| `animate` | boolean | animation on progress bar. |

projects/igniteui-angular/src/lib/slider/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import { IgxSliderComponent } from "../../../src/main";
3939

4040
##### Enums
4141

42-
###### SliderType
42+
###### IgxSliderType
4343

4444
| Name | Description |
4545
| :--- | :---------- |
@@ -68,7 +68,7 @@ import { IgxSliderComponent } from "../../../src/main";
6868
| minValue | number | The minimal value for the slider. |
6969
| step | number | The incremental/decremental step of the value when dragging the thumb. The default step is 1, and step should be greater than 0. |
7070
| thumbLabelVisibilityDuration | number | The duration visibility of thumbs labels. The default value is 750 milliseconds. |
71-
| type | [SliderType](#slidertype) | Sets the SliderType, which is SLIDER or RANGE. |
71+
| type | [IgxSliderType](#slidertype) | Sets the IgxSliderType, which is SLIDER or RANGE. |
7272
| upperBound | number | The lower boundary of the slider value. If not set is the same as max value. |
7373
| value | number\|[IRangeSliderValue](#irangeslidervalue) | The slider value. If the slider is of type SLIDER the argument is number. By default if no value is set the default value is same as lower upper bound. If the slider type is RANGE then the argument is object containing lower and upper properties for the values. By default if no value is set the default value is for lower value it is the same as lower bound and if no value is set for the upper value it is the same as the upper bound.
7474

projects/igniteui-angular/src/lib/tabs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ There are two tabs types that specify the sizing mechanism of the items.
2525
- `fixed`
2626

2727

28-
You can set the tabs type using the `tabsType` input.
28+
You can set the tabs type using the `type` input.
2929

3030
### Fixed Type
3131
All tabs items have equal size. The width of each tab is calculated by taking the width of the view and dividing it by the number of tabs. The width is in the range of min/max widths specified in Material Design.
@@ -48,7 +48,7 @@ If the total visible items width exceeds the vew port width, scroll buttons are
4848
| `icon` | string | Set the icon to the item. Currently all icons from the material icon set are supported. |
4949
| `label` | string | Set the tab item text. |
5050
| `disabled` | boolean | Set if the tab is enabled/disabled. |
51-
| `tabsType` | TabsType | Set the tab item sizing mode. By default, `contentfit` is set, the tab item width is sized to its content in the range of min/max width. When the sizing type is `fixed` - all tabs have equal size to fit the view port. |
51+
| `type` | IgxTabsType | Set the tab item sizing mode. By default, `contentfit` is set, the tab item width is sized to its content in the range of min/max width. When the sizing type is `fixed` - all tabs have equal size to fit the view port. |
5252

5353
## Events
5454

0 commit comments

Comments
 (0)