monobill-mintui 0.1.5 → 0.1.7

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.
Files changed (5) hide show
  1. package/README.md +35 -0
  2. package/dist/components/icon/Icon.d.ts.map +1 -1
  3. package/dist/index.cjs +3 -3
  4. package/dist/index.js +180 -177
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -42,6 +42,41 @@ module.exports = {
42
42
 
43
43
  **After updating your Tailwind config, rebuild your CSS** (restart your dev server or rebuild your Tailwind output).
44
44
 
45
+ ## Icon Configuration
46
+
47
+ Icons are loaded from SVG files. By default, icons load from the CDN at `https://assets.gomonobill.com/mintui/icons/` for optimal caching and performance.
48
+
49
+ ### Configuring Icon Source
50
+
51
+ You can configure where icons are loaded from using a meta tag:
52
+
53
+ **Default (CDN):**
54
+ ```html
55
+ <!-- Icons load from CDN by default -->
56
+ <mint-icon name="caret-up"></mint-icon>
57
+ ```
58
+
59
+ **Load from Local Server:**
60
+ ```html
61
+ <meta name="mint-icon-base-url" content="local">
62
+ ```
63
+
64
+ **Load from Custom Endpoint:**
65
+ ```html
66
+ <meta name="mint-icon-base-url" content="/custom/path/to/icons">
67
+ <!-- or -->
68
+ <meta name="mint-icon-base-url" content="https://your-cdn.com/icons">
69
+ ```
70
+
71
+ **Explicitly Use CDN:**
72
+ ```html
73
+ <meta name="mint-icon-base-url" content="cdn">
74
+ ```
75
+
76
+ ### Icon Files Setup
77
+
78
+ If using local icons, ensure SVG files are available in your `public/icons/` directory. The icon component expects files named like `/icons/caret-up.svg`, `/icons/caret-down.svg`, etc.
79
+
45
80
  ## Usage
46
81
 
47
82
  ### Framework-Agnostic Web Components
package/dist/components/icon/Icon.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Icon.d.ts","sourceRoot":"","sources":["../../../src/components/icon/Icon.ts"],"names":[],"mappings":"AAYA,cAAM,QAAS,SAAQ,WAAW;IAChC,MAAM,KAAK,kBAAkB,IAAI,MAAM,EAAE,CAExC;IAED,OAAO,CAAC,iBAAiB,CAAgC;;IAOzD,iBAAiB,IAAI,IAAI;IAQzB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAM9F,oBAAoB,IAAI,IAAI;IAQ5B,OAAO,CAAC,gBAAgB;IAsBxB,OAAO,IAAI,MAAM;IAIjB,UAAU,IAAI,MAAM;IAapB,MAAM,IAAI,IAAI;CAqFf;AAOD,eAAe,QAAQ,CAAA"}
1
+ {"version":3,"file":"Icon.d.ts","sourceRoot":"","sources":["../../../src/components/icon/Icon.ts"],"names":[],"mappings":"AAIA,cAAM,QAAS,SAAQ,WAAW;IAChC,MAAM,KAAK,kBAAkB,IAAI,MAAM,EAAE,CAExC;IAED,OAAO,CAAC,iBAAiB,CAAgC;;IAOzD,iBAAiB,IAAI,IAAI;IAQzB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAM9F,oBAAoB,IAAI,IAAI;IAQ5B,OAAO,CAAC,gBAAgB;IAsBxB,OAAO,IAAI,MAAM;IAIjB,UAAU,IAAI,MAAM;IAwBpB,MAAM,IAAI,IAAI;CAgGf;AAOD,eAAe,QAAQ,CAAA"}