@startupjs-ui/icon 0.1.13 → 0.1.19

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.1.19](https://github.com/startupjs/startupjs-ui/compare/v0.1.18...v0.1.19) (2026-03-17)
+
+
+### Bug Fixes
+
+* **docs:** don't load all icons to keep bundle small ([#17](https://github.com/startupjs/startupjs-ui/issues/17)) ([d7eb70b](https://github.com/startupjs/startupjs-ui/commit/d7eb70bc11f5b15923f2e43b7ef1f86ea066494e))
+
+
+
+
+
+## [0.1.16](https://github.com/startupjs/startupjs-ui/compare/v0.1.15...v0.1.16) (2026-02-10)
+
+**Note:** Version bump only for package @startupjs-ui/icon
+
+
+
+
+
 ## [0.1.13](https://github.com/startupjs/startupjs-ui/compare/v0.1.12...v0.1.13) (2026-02-03)
 
 **Note:** Version bump only for package @startupjs-ui/icon

package/README.mdx

@@ -3,11 +3,9 @@ import Icon, { _PropsJsonSchema as IconPropsJsonSchema } from './index'
 import Div from '@startupjs-ui/div'
 import Br from '@startupjs-ui/br'
 import TextInput from '@startupjs-ui/text-input'
-import {
-  faHouseUser,
-  faTable,
-  faShareAlt
-} from '@fortawesome/free-solid-svg-icons'
+import { faHouseUser } from '@fortawesome/free-solid-svg-icons/faHouseUser'
+import { faTable } from '@fortawesome/free-solid-svg-icons/faTable'
+import { faShareAlt } from '@fortawesome/free-solid-svg-icons/faShareAlt'
 import CustomIconExample from './CustomIconExample.svg'
 import { Sandbox } from '@startupjs-ui/docs'
 import './index.mdx.cssx.styl'
@@ -16,16 +14,18 @@ import './index.mdx.cssx.styl'
 
 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.
 
+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).
+
 ```jsx
 import { Icon } from 'startupjs-ui'
 ```
 
 ## Simple example
 
-Component uses `@fortawesome/react-native-fontawesome` library to implement icons.
+The component uses the `@fortawesome/react-native-fontawesome` library for rendering icons.
 
 ```jsx
-import { faHouseUser } from '@fortawesome/free-solid-svg-icons'
+import { faHouseUser } from '@fortawesome/free-solid-svg-icons/faHouseUser'
 ```
 
 ```jsx example
@@ -36,7 +36,7 @@ return (
 
 ## Custom Icon
 
-To use your custom icon you must provide a valid `svg` icon to `icon` property
+To use a custom icon, pass a valid SVG component to the `icon` prop.
 
 ```jsx
 import CustomIconExample from './CustomIconExample.svg'
@@ -54,14 +54,12 @@ return (
 
 ## Sizes
 
-Size can be modified using the `size` prop. Default value is `m`. Pre defined icon size values are `xs`, `s`, `m`, `l`, `xl`, `xxl`. Size can also be arbitarily increased or decreased by providing a number to `size` prop. For a custom icon, you can set a different size of width and height using styles.
+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`.
 
 ```jsx
-import {
-  faHouseUser,
-  faTable,
-  faShareAlt
-} from '@fortawesome/free-solid-svg-icons'
+import { faHouseUser } from '@fortawesome/free-solid-svg-icons/faHouseUser'
+import { faTable } from '@fortawesome/free-solid-svg-icons/faTable'
+import { faShareAlt } from '@fortawesome/free-solid-svg-icons/faShareAlt'
 import CustomIconExample from './CustomIconExample.svg'
 ```
 
@@ -92,7 +90,7 @@ return (
 
 ## Colors
 
-Color can be set by specifying the `color` in StyleSheet.
+Set the icon color by specifying `color` in the stylesheet.
 
 In `.styl` file
 ```stylus
@@ -108,11 +106,9 @@ In `.styl` file
 ```
 
 ```jsx
-import {
-  faHouseUser,
-  faTable,
-  faShareAlt
-} from '@fortawesome/free-solid-svg-icons'
+import { faHouseUser } from '@fortawesome/free-solid-svg-icons/faHouseUser'
+import { faTable } from '@fortawesome/free-solid-svg-icons/faTable'
+import { faShareAlt } from '@fortawesome/free-solid-svg-icons/faShareAlt'
 ```
 
 ```jsx example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@startupjs-ui/icon",
-  "version": "0.1.13",
+  "version": "0.1.19",
   "publishConfig": {
     "access": "public"
   },
@@ -15,12 +15,12 @@
     "@fortawesome/fontawesome-svg-core": "^1.2.26",
     "@fortawesome/free-solid-svg-icons": "^7.1.0",
     "@fortawesome/react-native-fontawesome": "^0.3.0",
-    "@startupjs-ui/core": "^0.1.11"
+    "@startupjs-ui/core": "^0.1.19"
   },
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
     "startupjs": "*"
   },
-  "gitHead": "5cfdccf2bdae3873e968289a3e6b938fad02101a"
+  "gitHead": "bfcca786dc363f42a09b6eef4feb7ca8139302fc"
 }