material-design-icons-literal-types 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +5 -0
- package/README.md +40 -0
- package/dist/material-icons.d.ts +2258 -0
- package/dist/material-symbols.d.ts +3585 -0
- package/package.json +39 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
Copyright 2024 Oliver Grüttner
|
|
2
|
+
|
|
3
|
+
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
|
|
4
|
+
|
|
5
|
+
THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Material Design Icons Literal Types
|
|
2
|
+
|
|
3
|
+
This package provides TypeScript literal types for the icon names from
|
|
4
|
+
the [Google Material Design Icons](https://github.com/google/material-design-icons) repository.
|
|
5
|
+
It allows you to use the icon names with type safety in your TypeScript projects.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Install the package using npm:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install material-design-icons-literal-types
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
Import the desired icon type from the package:
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {MaterialSymbols} from 'material-design-icons-literal-types'
|
|
21
|
+
|
|
22
|
+
const myIcon: MaterialSymbols = 'home'
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The package provides the following literal types:
|
|
26
|
+
|
|
27
|
+
- `MaterialSymbols`: Icon names for the Material Symbols icon set.
|
|
28
|
+
- `MaterialIcons`: Icon names for the Material Icons icon set.
|
|
29
|
+
|
|
30
|
+
Using these literal types ensures that you are using valid icon names and helps catch typos during development.
|
|
31
|
+
|
|
32
|
+
## Updating Icon Types
|
|
33
|
+
|
|
34
|
+
The icon types are automatically updated every Monday, Wednesday, and Friday at midnight (UTC) through a GitHub Actions
|
|
35
|
+
workflow.
|
|
36
|
+
This ensures that the package stays up to date with the latest icons from the Material Design Icons repository.
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
This project is licensed under the ISC License - see the [LICENSE](./LICENSE) file for details.
|