@musecat/uikit 0.1.1 → 0.1.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.
Files changed (56) hide show
  1. package/.agents/references/Components/Box.md +60 -0
  2. package/.agents/references/Components/Button.md +49 -0
  3. package/.agents/references/Components/Card.md +67 -0
  4. package/.agents/references/Components/Checkbox.md +48 -0
  5. package/.agents/references/Components/CodeBox.md +31 -0
  6. package/.agents/references/Components/ContextMenu.md +82 -0
  7. package/.agents/references/Components/ContributionGraph.md +61 -0
  8. package/.agents/references/Components/DatePicker.md +92 -0
  9. package/.agents/references/Components/Divider.md +56 -0
  10. package/.agents/references/Components/Header.md +52 -0
  11. package/.agents/references/Components/Icon.md +82 -0
  12. package/.agents/references/Components/Input.md +60 -0
  13. package/.agents/references/Components/Label.md +78 -0
  14. package/.agents/references/Components/Layout.md +102 -0
  15. package/.agents/references/Components/Maps.md +63 -0
  16. package/.agents/references/Components/Nav.md +68 -0
  17. package/.agents/references/Components/Pagination.md +67 -0
  18. package/.agents/references/Components/Pill.md +75 -0
  19. package/.agents/references/Components/Profile.md +76 -0
  20. package/.agents/references/Components/Progress.md +72 -0
  21. package/.agents/references/Components/Radio.md +68 -0
  22. package/.agents/references/Components/Select.md +80 -0
  23. package/.agents/references/Components/Skeleton.md +48 -0
  24. package/.agents/references/Components/Spinner.md +62 -0
  25. package/.agents/references/Components/Text.md +73 -0
  26. package/.agents/references/Components/TimePicker.md +72 -0
  27. package/.agents/references/Components/Timeline.md +97 -0
  28. package/.agents/references/Components/Title.md +108 -0
  29. package/.agents/references/Components/Toggle.md +53 -0
  30. package/.agents/references/Components/Tooltip.md +62 -0
  31. package/.agents/references/Frameworks/DNDView.md +82 -0
  32. package/.agents/references/Frameworks/Dialog.md +109 -0
  33. package/.agents/references/Frameworks/EdgeEffect.md +64 -0
  34. package/.agents/references/Frameworks/HScrollView.md +76 -0
  35. package/.agents/references/Frameworks/ImageView.md +67 -0
  36. package/.agents/references/Frameworks/Motion.md +62 -0
  37. package/.agents/references/Frameworks/Pressable.md +79 -0
  38. package/.agents/references/Frameworks/Squircle.md +50 -0
  39. package/.agents/references/Frameworks/Theme.md +68 -0
  40. package/.agents/references/Frameworks/Toaster.md +67 -0
  41. package/.agents/references/Frameworks/View.md +81 -0
  42. package/.agents/references/Frameworks/_shared.md +74 -0
  43. package/.agents/references/Styles/Animation.md +43 -0
  44. package/.agents/references/Styles/Color.md +45 -0
  45. package/.agents/references/Styles/Font.md +37 -0
  46. package/.agents/references/Styles/Icon.md +43 -0
  47. package/.agents/references/Styles/Importer.md +19 -0
  48. package/.agents/references/Styles/System.md +27 -0
  49. package/.agents/references/Styles/Textstyle.md +45 -0
  50. package/.agents/references/Styles/Theme.md +51 -0
  51. package/.agents/references/Styles/Viewport-global.md +42 -0
  52. package/.agents/references/Styles/Viewport.md +42 -0
  53. package/README.md +4 -0
  54. package/package.json +2 -1
  55. package/packages/Styles/_icon.scss +2 -0
  56. package/packages/Styles/_importer.scss +0 -1
@@ -0,0 +1,42 @@
1
+ # Viewport
2
+
3
+ This document defines viewport mixin functions for easily writing media queries within SCSS.
4
+
5
+ ## Configuration
6
+
7
+ Manages the breakpoint ranges (min, max, next) of `w1`, `w2`, `w3`, `w4` as a Map object.
8
+
9
+ ## Mixins
10
+
11
+ - `@mixin viewport-max($max)`: Generates a max-width based media query
12
+ - `@mixin viewport-min($min)`: Generates a min-width based media query
13
+ - `@mixin viewport-between($min, $max)`: Generates a range-specified media query
14
+
15
+ ### Helper Mixins
16
+
17
+ - `@mixin down($key)`: Applies at or below the max-width of a specific keyword (e.g., `w3`). Useful when writing mobile-first views.
18
+ - `@mixin up($key)`: Applies at or above the min-width of a specific keyword. Useful when writing PC-first views.
19
+ - `@mixin only($key)`: Applies exactly within the min ~ max range of a specific keyword.
20
+
21
+ ## Usage
22
+
23
+ Import `_viewport.scss` as a module when designing custom components to control media queries.
24
+
25
+ ```scss
26
+ @use "../../Styles/viewport" as vp;
27
+
28
+ .container {
29
+ padding: 2rem;
30
+
31
+ @include vp.down(w3) {
32
+ // Applied on screens 767.98px or below
33
+ padding: 1rem;
34
+ flex-direction: column;
35
+ }
36
+
37
+ @include vp.only(w2) {
38
+ // Applied only on screens 320px ~ 409.98px
39
+ background: red;
40
+ }
41
+ }
42
+ ```
package/README.md CHANGED
@@ -36,6 +36,10 @@ export default function Example() {
36
36
  }
37
37
  ```
38
38
 
39
+ ## References
40
+
41
+ This package includes `.agents/references/` directory with detailed documentation for every component, framework, and style system. Use it alongside TypeScript definitions as a guide when building with `@musecat/uikit`.
42
+
39
43
  ## Acknowledgements
40
44
 
41
45
  - [Motion (Framer Motion)](https://motion.dev/)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@musecat/uikit",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "High-performance Next.js React UI component library with Squircle shapes, theme tokens, and gesture-driven overlays",
@@ -34,6 +34,7 @@
34
34
  "files": [
35
35
  "index.ts",
36
36
  "packages/",
37
+ ".agents/",
37
38
  "README.md",
38
39
  "LICENSE"
39
40
  ],
@@ -10,6 +10,8 @@ i,
10
10
  i::before,
11
11
  i::after,
12
12
  blockquote::before {
13
+ line-height: 1;
14
+ font-style: normal;
13
15
  font-family: var(--font-icon);
14
16
  font-variation-settings:
15
17
  "rond" 2,
@@ -1,7 +1,6 @@
1
1
  @use "animation";
2
2
  @use "color";
3
3
  @use "font";
4
- @use "icon";
5
4
  @use "system";
6
5
  @use "textstyle";
7
6
  @use "theme";