Skip to content
This repository was archived by the owner on Jul 13, 2022. It is now read-only.

Commit 4211463

Browse files
committedNov 17, 2021
chore: 3.0.0-alpha.2 release for CoreUI 4
1 parent deef4ae commit 4211463

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed
 

‎README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,20 @@
1111
[coreui-angular-icons-npm]: https://www.npmjs.com/package/@coreui/icons-angular
1212
[npm-coreui-icons-angular-next]: https://img.shields.io/npm/v/@coreui/icons-angular/next.png?style=flat-square
1313

14-
## `c-icon` component
14+
## `cIcon` directive
1515

16-
Angular component for [CoreUI Icons SVG set](https://coreui.io/icons/).
16+
Angular directive for [CoreUI Icons SVG set](https://coreui.io/icons/).
1717

1818
### Features
1919

20-
- Loads icons in three ways:
21-
- stored globally in Angular service,
22-
- directly passed SVG tag content,
23-
- source link to SVG file
24-
- Reduces icons bundle size when imported as single icons,
25-
- Full functionality of `<svg>` html tag,
20+
- Load icons:
21+
- stored in Angular root service,
22+
- directly passed SVG content,
23+
- Reduce icons bundle size when imported as single icons,
24+
- Full functionality of `<svg>` tag,
2625
- Clean API
2726

28-
For component description visit [CIcon component documentation](https://icons.coreui.io/docs/using-coreui-icons-with/angular/)
27+
For directive description visit [https://coreui.io/angular/docs/4.0/](https://coreui.io/angular/docs/4.0/)
2928

3029
### Installation
3130

@@ -70,24 +69,23 @@ export class AppComponent implements OnInit {
7069
```
7170
7271
```jsx
73-
<c-icon name="cil-envelope-open" size="lg"></c-icon>
74-
<c-icon name="cifAu"></c-icon>
72+
<svg cIcon name="cil-envelope-open" size="lg"></svg>
73+
<svg cIcon name="cifAu"></svg>
7574
```
7675
7776
### API
78-
> Use one of `name`, `src` or `content` prop as it defines the way of icon import
77+
> Use one of `name` or `content` prop as it defines the way of icon import
78+
79+
##### Inputs
7980
8081
proprerty | type | default | description
8182
---|---|---|---
8283
`name` | string | undefined | name of SVG icon stored in IconSetService
8384
`content` | string, string[] | undefined | SVG content
84-
`src` | string | undefined | Link to the icon. If defined, component will be rendered as `<img>` tag |
85-
`size` | `custom`, `custom-size`, `sm`, `lg`, `xl`, `2xl`, `3xl`, `4xl`, `5xl`, `6xl`, `7xl`, `8xl`, `9xl` | '' | Size of icon
85+
`size` | `custom`, `custom-size`, `sm`, `lg`, `xl`, `xxl`, `3xl`, `4xl`, `5xl`, `6xl`, `7xl`, `8xl`, `9xl` | '' | Size of icon
8686
`title` | string | undefined |
87-
`use` | string | undefined | SVG `<use>`
8887
`customClasses` | string | undefined | Overwrites default `.icon` classes
8988
`viewBox` | string | undefined | SVG `viewbox`
90-
`attributes` | any | `{ role: 'img' }` | Object with additional html attributes
9189
`width` | string | undefined | SVG `width`
9290
`height` | string | undefined | SVG `height`
9391

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "coreui-icons-angular",
3-
"version": "3.0.0-alpha.1",
3+
"version": "3.0.0-alpha.2",
44
"description": "CoreUI Icons Angular component",
55
"license": "MIT",
66
"homepage": "https://coreui.io",

‎projects/coreui-icons-angular/.eslintrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@
3131
"prefix": "c",
3232
"style": "kebab-case"
3333
}
34+
],
35+
"@angular-eslint/no-input-rename": [
36+
"warn"
3437
]
3538
}
3639
},

‎projects/coreui-icons-angular/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreui/icons-angular",
3-
"version": "3.0.0-alpha.1",
3+
"version": "3.0.0-alpha.2",
44
"description": "CoreUI Icons Angular component and service",
55
"copyright": "Copyright 2021 creativeLabs Łukasz Holeczek",
66
"license": "MIT",

0 commit comments

Comments
 (0)
This repository has been archived.