# @logo-software/icons

> Icon Module is used to add icons to Logo Elements Design System guide-based web and mobile applications. Our icons depend on the *Streamline Icons* paid version. For usage, just download and import `scss` to your project main `style.scss` is enough. It is

Latest version **11.0.0** (published 2022-10-10) · See license in LICENSE file license · 0 weekly downloads

## Install

```sh
npm install @logo-software/icons
pnpm add @logo-software/icons
yarn add @logo-software/icons
bun add @logo-software/icons
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 11.0.0 |
| Published | 2022-10-10 |
| First published | 2020-05-11 |
| Weekly downloads | 0 |
| License | See license in LICENSE file |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Serkan Konakcı |
| Maintainers | serdarates, gamzeyapici, hakan.tunc, srknc, dotnet-ankara, murat.logo, serhan.gurbuz, gulnihaleksi |
| Keywords | icon, app, web, mobile, svg, angular |

## Links

- npm: https://www.npmjs.com/package/@logo-software/icons
- Repository: http://stash.logo.com.tr/scm/fd/theme
- Homepage: http://elements.logo.com.tr
- npm.io page: https://npm.io/package/@logo-software/icons

## Dependencies (2)

- [tslib](https://npm.io/package/tslib.md) ^1.10.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 11.0.0 (latest) — 2022-10-10
- 4.0.0 — 2022-09-05
- 1.7.6 — 2022-07-20
- 1.7.5 — 2021-10-12
- 1.7.4 — 2021-10-12
- 1.7.3 — 2021-10-06
- 1.7.2 — 2021-10-05
- 1.7.1 — 2021-10-04
- 1.7.0 — 2021-10-04
- 1.5.2 — 2021-03-22
- 1.3.3 — 2020-09-20
- 1.3.1 — 2020-09-01
- 1.3.0 — 2020-09-01
- 1.1.6 — 2020-08-05
- 1.1.5 — 2020-08-05
- … 11 more at https://npm.io/package/@logo-software/icons/versions

## README

# Icon Module
Icon Module is used to add icons to Logo Elements Design System guide-based web and mobile applications. Our icons depend on the *Streamline Icons* paid version. For usage, just download and import `scss` to your project main `style.scss` is enough. It is so easy to use.

Click here for [demo](http://design.logo.com.tr/#/docs/components/icon-module#iconmodule)

### License
Our licence placed at [License](http://design.logo.com.tr/assets/guideline/icon/license.pdf) file. Please click and read for usage details.

### Installation
There are several ways to install Logo Icons to the project.

###### 1. Font Icon
Our icons also can be usable as Font Icon. You can download Font Icon version to your project from [here](http://design.logo.com.tr/assets/guideline/icon/LogoElements-v1.5.1.zip).

###### 2. Bitbucket
1. Download Icons's `scss` file from [Bitbucket](http://stash.logo.com.tr/projects/FD/repos/theme/browse/projects/logo-software/icons/style.scss).
2. Save as "style-file-name.css"
3. Place it to your `assets` folder, or where you want
4. Open your main `css` file.
5. Then add below code for import it to your own css file
 ```scss
 @import url("./folder-path/style.css");
 ```

###### 3. Npm
This package is private package so we decide to hold it in our own repository. Other side, our all public npm packages is located at [https://www.npmjs.com/~logofe](https://www.npmjs.com/~logofe).

To install Icons Module throught npm:

1. Set your npm registry to Logo Nexus Repository Manager if not [https://dregistry.logo.com.tr/](dregistry.logo.com.tr).
```shell
$ npm set registry https://dregistry.logo.com.tr/repository/npm-logofe/
```
2. Please login for authentication, if you are not signed in.
```shell
$ npm login
```
3. At your project call `npm install` command. This below command will create `node_modules` folder at same level path.
```shell
$ npm install @logo-software/icons -s
```
4. Then add below code for import it to your own scss file
```scss
@import "./node_modules/@logo-software/icons/style";
```

### Usage In Angular Component
Below code sample was created for Angular based applications. Our icon module is not dependent on any platform file. You can use it in every web application.

<sub>your-main-style.scss</sub>
```scss
// import icon style your scss code
@import "~@logo-software/icons/style";

body{}
```
<sub>any.component.html</sub>
```html
<!-- this will add search icon to input to right side of it.-->
<button class="le-search icon-right">Right</button>
<!-- this code add search icon to the left side-->
<button class="le-search icon-left">Left</button
  <!-- this code add search icon to the center (default)-->
<button class="le-save">Center</button>
```

For more detail please visit: [Icons Module](http://design.logo.com.tr/#/docs/components/icons-module#iconsmodule)

---
_Source: https://npm.io/package/@logo-software/icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._