@startupjs-ui/icon 0.1.13 → 0.1.16
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/CHANGELOG.md +8 -0
- package/README.mdx +6 -4
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.1.16](https://github.com/startupjs/startupjs-ui/compare/v0.1.15...v0.1.16) (2026-02-10)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @startupjs-ui/icon
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [0.1.13](https://github.com/startupjs/startupjs-ui/compare/v0.1.12...v0.1.13) (2026-02-03)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @startupjs-ui/icon
|
package/README.mdx
CHANGED
|
@@ -16,13 +16,15 @@ import './index.mdx.cssx.styl'
|
|
|
16
16
|
|
|
17
17
|
Icons are visual symbols used to represent ideas, objects, or actions. They communicate messages at a glance, afford interactivity, and draw attention to important information.
|
|
18
18
|
|
|
19
|
+
The `icon` prop accepts a FontAwesome icon definition, a custom SVG component, or a registered icon name. You can apply custom `style` to control the icon's appearance (including color).
|
|
20
|
+
|
|
19
21
|
```jsx
|
|
20
22
|
import { Icon } from 'startupjs-ui'
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
## Simple example
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
The component uses the `@fortawesome/react-native-fontawesome` library for rendering icons.
|
|
26
28
|
|
|
27
29
|
```jsx
|
|
28
30
|
import { faHouseUser } from '@fortawesome/free-solid-svg-icons'
|
|
@@ -36,7 +38,7 @@ return (
|
|
|
36
38
|
|
|
37
39
|
## Custom Icon
|
|
38
40
|
|
|
39
|
-
To use
|
|
41
|
+
To use a custom icon, pass a valid SVG component to the `icon` prop.
|
|
40
42
|
|
|
41
43
|
```jsx
|
|
42
44
|
import CustomIconExample from './CustomIconExample.svg'
|
|
@@ -54,7 +56,7 @@ return (
|
|
|
54
56
|
|
|
55
57
|
## Sizes
|
|
56
58
|
|
|
57
|
-
|
|
59
|
+
The `size` prop controls the icon dimensions. It defaults to `'m'`. Predefined size presets are `'xs'`, `'s'`, `'m'`, `'l'`, `'xl'`, and `'xxl'`. You can also pass a number for an arbitrary pixel size. For custom SVG icons, you can set different width and height values using `style`.
|
|
58
60
|
|
|
59
61
|
```jsx
|
|
60
62
|
import {
|
|
@@ -92,7 +94,7 @@ return (
|
|
|
92
94
|
|
|
93
95
|
## Colors
|
|
94
96
|
|
|
95
|
-
|
|
97
|
+
Set the icon color by specifying `color` in the stylesheet.
|
|
96
98
|
|
|
97
99
|
In `.styl` file
|
|
98
100
|
```stylus
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@startupjs-ui/icon",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.16",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -22,5 +22,5 @@
|
|
|
22
22
|
"react-native": "*",
|
|
23
23
|
"startupjs": "*"
|
|
24
24
|
},
|
|
25
|
-
"gitHead": "
|
|
25
|
+
"gitHead": "9943aa3566d5d80f5b404473906eb3c0611f9ee5"
|
|
26
26
|
}
|