@rimelight/ui 0.0.33 → 0.0.34
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/README.md +157 -157
- package/package.json +105 -105
- package/src/components/astro/RLAAspectRatio.astro +2 -2
- package/src/components/astro/RLAButton.astro +141 -139
- package/src/components/astro/RLAChart.astro +19 -34
- package/src/components/astro/RLAHead.astro +427 -196
- package/src/components/astro/RLAHeader.astro +66 -59
- package/src/components/astro/RLAImage.astro +61 -19
- package/src/components/astro/RLALink.astro +22 -23
- package/src/components/astro/RLALinkGroup.astro +66 -4
- package/src/components/astro/RLALocaleSelector.astro +136 -113
- package/src/components/astro/RLAMain.astro +8 -3
- package/src/components/astro/RLAMarquee.astro +9 -2
- package/src/components/astro/RLANavigationMenu.astro +245 -56
- package/src/components/astro/RLAPagination.astro +2 -4
- package/src/components/astro/RLAProgress.astro +8 -2
- package/src/components/astro/RLASelect.astro +38 -24
- package/src/components/astro/RLASlideover.astro +66 -1
- package/src/components/astro/RLASlider.astro +14 -14
- package/src/components/astro/RLASplitter.astro +14 -2
- package/src/components/astro/RLAStickySurface.astro +9 -2
- package/src/components/vue/RLVCheckbox.vue +68 -68
- package/src/components/vue/RLVForm.vue +44 -44
- package/src/components/vue/RLVFormField.vue +58 -58
- package/src/components/vue/RLVInput.vue +93 -93
- package/src/components/vue/RLVPost.vue +63 -63
- package/src/components/vue/RLVPosts.vue +21 -21
- package/src/components/vue/RLVToast.vue +68 -68
- package/src/components/vue/RLVToaster.vue +29 -29
- package/src/composables/index.ts +3 -3
- package/src/composables/useHeaderStore.ts +13 -14
- package/src/composables/useScrollToTop.ts +62 -62
- package/src/composables/useToast.ts +43 -42
- package/src/config/index.ts +1 -0
- package/src/config/security.ts +220 -0
- package/src/integrations/ui.ts +199 -199
- package/src/middleware/security.ts +75 -15
- package/src/plugins/index.ts +2 -2
- package/src/plugins/starlightDocsApi/index.ts +272 -272
- package/src/presets/defaults.ts +297 -297
- package/src/presets/index.ts +683 -637
- package/src/styles/index.css +160 -160
- package/src/themes/3d-hover.theme.ts +13 -13
- package/src/themes/accordion.theme.ts +13 -13
- package/src/themes/alert.theme.ts +131 -125
- package/src/themes/app.theme.ts +13 -13
- package/src/themes/audio.theme.ts +13 -13
- package/src/themes/avatar.theme.ts +84 -84
- package/src/themes/badge.theme.ts +169 -163
- package/src/themes/banner.theme.ts +13 -13
- package/src/themes/browser-mockup.theme.ts +13 -13
- package/src/themes/button.theme.ts +224 -202
- package/src/themes/calendar.theme.ts +13 -13
- package/src/themes/card.theme.ts +42 -42
- package/src/themes/changelog.theme.ts +13 -13
- package/src/themes/chart.theme.ts +22 -22
- package/src/themes/chat-message.theme.ts +13 -13
- package/src/themes/chat-messages.theme.ts +13 -13
- package/src/themes/chat-palette.theme.ts +13 -13
- package/src/themes/chat-prompt-submit.theme.ts +13 -13
- package/src/themes/chat-prompt.theme.ts +13 -13
- package/src/themes/chat-reasoning.theme.ts +13 -13
- package/src/themes/chat-shimmer.theme.ts +13 -13
- package/src/themes/chat-tool.theme.ts +13 -13
- package/src/themes/chat.theme.ts +13 -13
- package/src/themes/checkbox.theme.ts +50 -50
- package/src/themes/chip.theme.ts +74 -74
- package/src/themes/color-picker.theme.ts +13 -13
- package/src/themes/command-palette.theme.ts +13 -13
- package/src/themes/compare.theme.ts +13 -13
- package/src/themes/confirm.theme.ts +48 -48
- package/src/themes/container.theme.ts +13 -13
- package/src/themes/context-menu.theme.ts +13 -13
- package/src/themes/dashboard-group.theme.ts +13 -13
- package/src/themes/dashboard-navbar.theme.ts +13 -13
- package/src/themes/dashboard-panel.theme.ts +13 -13
- package/src/themes/dashboard-resize-handle.theme.ts +13 -13
- package/src/themes/dashboard-search-button.theme.ts +13 -13
- package/src/themes/dashboard-search.theme.ts +13 -13
- package/src/themes/dashboard-sidebar-collapse.theme.ts +13 -13
- package/src/themes/dashboard-sidebar-toggle.theme.ts +13 -13
- package/src/themes/dashboard-sidebar.theme.ts +13 -13
- package/src/themes/dashboard-toolbar.theme.ts +13 -13
- package/src/themes/dock.theme.ts +13 -13
- package/src/themes/drawer.theme.ts +61 -61
- package/src/themes/dropdown-menu.theme.ts +29 -29
- package/src/themes/editor.theme.ts +13 -13
- package/src/themes/empty.theme.ts +13 -13
- package/src/themes/error.theme.ts +13 -13
- package/src/themes/field-group.theme.ts +24 -24
- package/src/themes/fieldset.theme.ts +13 -13
- package/src/themes/floating-action.theme.ts +13 -13
- package/src/themes/footer.theme.ts +30 -30
- package/src/themes/form.theme.ts +13 -13
- package/src/themes/gallery.theme.ts +13 -13
- package/src/themes/head.theme.ts +13 -13
- package/src/themes/header.theme.ts +45 -46
- package/src/themes/icon.theme.ts +23 -23
- package/src/themes/image.theme.ts +23 -19
- package/src/themes/input-date.theme.ts +13 -13
- package/src/themes/input-menu.theme.ts +35 -35
- package/src/themes/input-number.theme.ts +13 -13
- package/src/themes/input-tags.theme.ts +13 -13
- package/src/themes/input-time.theme.ts +13 -13
- package/src/themes/input.theme.ts +42 -42
- package/src/themes/kbd.theme.ts +95 -89
- package/src/themes/knob.theme.ts +13 -13
- package/src/themes/link-group.theme.ts +32 -32
- package/src/themes/link.theme.ts +13 -13
- package/src/themes/listbox.theme.ts +13 -13
- package/src/themes/locale-selector.theme.ts +49 -49
- package/src/themes/logo.theme.ts +13 -13
- package/src/themes/main.theme.ts +13 -13
- package/src/themes/megamenu.theme.ts +13 -13
- package/src/themes/meter.theme.ts +13 -13
- package/src/themes/navigation-menu.theme.ts +44 -27
- package/src/themes/page-aside.theme.ts +13 -13
- package/src/themes/page-body.theme.ts +13 -13
- package/src/themes/page-header.theme.ts +13 -13
- package/src/themes/page-section.theme.ts +187 -187
- package/src/themes/page.theme.ts +13 -13
- package/src/themes/password.theme.ts +13 -13
- package/src/themes/phone-mockup.theme.ts +13 -13
- package/src/themes/placeholder.theme.ts +15 -15
- package/src/themes/post.theme.ts +33 -33
- package/src/themes/pricing-plan.theme.ts +13 -13
- package/src/themes/pricing-table.theme.ts +13 -13
- package/src/themes/progress.theme.ts +38 -38
- package/src/themes/prose.theme.ts +13 -13
- package/src/themes/qr-code.theme.ts +13 -13
- package/src/themes/quote.theme.ts +13 -13
- package/src/themes/radio-group.theme.ts +13 -13
- package/src/themes/rating.theme.ts +13 -13
- package/src/themes/scroll-area.theme.ts +26 -26
- package/src/themes/scroll-to-top.theme.ts +52 -52
- package/src/themes/select.theme.ts +29 -29
- package/src/themes/separator.theme.ts +147 -147
- package/src/themes/sidebar.theme.ts +38 -38
- package/src/themes/skeleton.theme.ts +21 -21
- package/src/themes/slideover.theme.ts +4 -4
- package/src/themes/slider.theme.ts +36 -36
- package/src/themes/speed-dial.theme.ts +13 -13
- package/src/themes/spinner.theme.ts +34 -34
- package/src/themes/splitter.theme.ts +23 -23
- package/src/themes/spoiler.theme.ts +13 -13
- package/src/themes/stepper.theme.ts +13 -13
- package/src/themes/switch.theme.ts +67 -67
- package/src/themes/table-of-contents.theme.ts +48 -48
- package/src/themes/tabs.theme.ts +52 -52
- package/src/themes/textarea.theme.ts +27 -27
- package/src/themes/theme-selector.theme.ts +15 -15
- package/src/themes/timeline.theme.ts +13 -13
- package/src/themes/toast.theme.ts +31 -31
- package/src/themes/tooltip.theme.ts +28 -28
- package/src/themes/tour.theme.ts +13 -13
- package/src/themes/tree.theme.ts +13 -13
- package/src/themes/user.theme.ts +13 -13
- package/src/themes/video.theme.ts +17 -17
- package/src/themes/watermark.theme.ts +13 -13
- package/src/themes/window-mockup.theme.ts +13 -13
- package/src/types/components/3d-hover.ts +11 -11
- package/src/types/components/alert.ts +2 -2
- package/src/types/components/app.ts +11 -11
- package/src/types/components/audio.ts +11 -11
- package/src/types/components/avatar-group.ts +11 -11
- package/src/types/components/avatar.ts +60 -60
- package/src/types/components/badge.ts +2 -2
- package/src/types/components/banner.ts +11 -11
- package/src/types/components/browser-mockup.ts +11 -11
- package/src/types/components/button.ts +74 -81
- package/src/types/components/calendar.ts +11 -11
- package/src/types/components/changelog.ts +11 -11
- package/src/types/components/chart.ts +2 -1
- package/src/types/components/chat-message.ts +11 -11
- package/src/types/components/chat-messages.ts +11 -11
- package/src/types/components/chat-palette.ts +11 -11
- package/src/types/components/chat-prompt-submit.ts +11 -11
- package/src/types/components/chat-prompt.ts +11 -11
- package/src/types/components/chat-reasoning.ts +11 -11
- package/src/types/components/chat-shimmer.ts +11 -11
- package/src/types/components/chat-tool.ts +11 -11
- package/src/types/components/chat.ts +11 -11
- package/src/types/components/checkbox.ts +2 -2
- package/src/types/components/chip.ts +17 -17
- package/src/types/components/collapsible.ts +2 -1
- package/src/types/components/color-picker.ts +11 -11
- package/src/types/components/command-palette.ts +11 -11
- package/src/types/components/compare.ts +11 -11
- package/src/types/components/container.ts +17 -17
- package/src/types/components/context-menu.ts +11 -11
- package/src/types/components/dashboard-group.ts +11 -11
- package/src/types/components/dashboard-navbar.ts +11 -11
- package/src/types/components/dashboard-panel.ts +11 -11
- package/src/types/components/dashboard-resize-handle.ts +11 -11
- package/src/types/components/dashboard-search-button.ts +11 -11
- package/src/types/components/dashboard-search.ts +11 -11
- package/src/types/components/dashboard-sidebar-collapse.ts +11 -11
- package/src/types/components/dashboard-sidebar-toggle.ts +11 -11
- package/src/types/components/dashboard-sidebar.ts +11 -11
- package/src/types/components/dashboard-toolbar.ts +11 -11
- package/src/types/components/dock.ts +11 -11
- package/src/types/components/dropdown-menu.ts +2 -1
- package/src/types/components/editor.ts +11 -11
- package/src/types/components/empty.ts +11 -11
- package/src/types/components/error.ts +11 -11
- package/src/types/components/fieldset.ts +11 -11
- package/src/types/components/file-upload.ts +2 -1
- package/src/types/components/floating-action.ts +11 -11
- package/src/types/components/form.ts +19 -19
- package/src/types/components/gallery.ts +11 -11
- package/src/types/components/icon.ts +19 -19
- package/src/types/components/image.ts +32 -28
- package/src/types/components/index.ts +134 -135
- package/src/types/components/input-date.ts +11 -11
- package/src/types/components/input-menu.ts +44 -43
- package/src/types/components/input-number.ts +11 -11
- package/src/types/components/input-pin.ts +36 -35
- package/src/types/components/input-tags.ts +11 -11
- package/src/types/components/input-time.ts +11 -11
- package/src/types/components/input.ts +2 -2
- package/src/types/components/knob.ts +11 -11
- package/src/types/components/link-group.ts +45 -23
- package/src/types/components/link.ts +4 -0
- package/src/types/components/listbox.ts +11 -11
- package/src/types/components/locale-selector.ts +33 -33
- package/src/types/components/logo.ts +32 -31
- package/src/types/components/main.ts +17 -17
- package/src/types/components/megamenu.ts +11 -11
- package/src/types/components/meter.ts +11 -11
- package/src/types/components/modal.ts +39 -39
- package/src/types/components/navigation-menu.ts +59 -54
- package/src/types/components/page-aside.ts +11 -11
- package/src/types/components/page-body.ts +11 -11
- package/src/types/components/page-header.ts +11 -11
- package/src/types/components/page.ts +11 -11
- package/src/types/components/password.ts +11 -11
- package/src/types/components/phone-mockup.ts +5 -5
- package/src/types/components/pin-input.ts +11 -11
- package/src/types/components/popover.ts +23 -23
- package/src/types/components/post.ts +35 -35
- package/src/types/components/pricing-plan.ts +11 -11
- package/src/types/components/pricing-table.ts +11 -11
- package/src/types/components/progress.ts +33 -33
- package/src/types/components/prose.ts +11 -11
- package/src/types/components/qr-code.ts +11 -11
- package/src/types/components/radio-group.ts +11 -11
- package/src/types/components/rating.ts +11 -11
- package/src/types/components/scroll-area.ts +23 -23
- package/src/types/components/scroll-to-top.ts +2 -2
- package/src/types/components/select.ts +2 -1
- package/src/types/components/separator.ts +19 -19
- package/src/types/components/sidebar.ts +87 -72
- package/src/types/components/slideover.ts +31 -31
- package/src/types/components/slider.ts +2 -2
- package/src/types/components/speed-dial.ts +11 -11
- package/src/types/components/spinner.ts +25 -25
- package/src/types/components/splitter.ts +19 -19
- package/src/types/components/spoiler.ts +11 -11
- package/src/types/components/stepper.ts +11 -11
- package/src/types/components/sticky-surface.ts +19 -19
- package/src/types/components/switch.ts +41 -41
- package/src/types/components/table-of-contents.ts +17 -17
- package/src/types/components/tabs.ts +2 -1
- package/src/types/components/textarea.ts +2 -1
- package/src/types/components/theme-selector.ts +15 -15
- package/src/types/components/timeline.ts +11 -11
- package/src/types/components/toast.ts +2 -1
- package/src/types/components/tooltip.ts +23 -23
- package/src/types/components/tour.ts +11 -11
- package/src/types/components/tree.ts +11 -11
- package/src/types/components/user.ts +11 -11
- package/src/types/components/watermark.ts +11 -11
- package/src/types/components/window-mockup.ts +11 -11
- package/src/types/theme.ts +10 -0
- package/src/utils/docs.ts +215 -189
- package/src/utils/headerStack.ts +95 -95
- package/src/utils/index.ts +5 -5
- package/src/components/astro/RLABlogPost.astro +0 -7
- package/src/components/astro/RLABlogPosts.astro +0 -9
- package/src/components/astro/RLAPosts.astro +0 -23
- package/src/themes/posts.theme.ts +0 -13
- package/src/types/components/posts.ts +0 -11
package/README.md
CHANGED
|
@@ -1,157 +1,157 @@
|
|
|
1
|
-
# Rimelight UI (@rimelight/ui)
|
|
2
|
-
|
|
3
|
-
[](https://astro.build)
|
|
4
|
-
|
|
5
|
-
[](https://playground.rimelight.com/ui)
|
|
6
|
-
[](https://rimelight.com/company/docs/packages/rimelight-ui/)
|
|
7
|
-
|
|
8
|
-
[](https://www.npmjs.com/package/@rimelight/ui)
|
|
9
|
-
[](https://www.npmjs.com/package/@rimelight/ui)
|
|
10
|
-
[](https://npmx.dev/package/@rimelight/ui)
|
|
11
|
-
|
|
12
|
-
Rimelight UI is a comprehensive component library for [Astro](https://astro.build) websites used and maintained by [Rimelight Entertainment](https://rimelight.com).
|
|
13
|
-
It offers a suite of accessible and highly performant components as [Astro Components](https://docs.astro.build/basics/astro-components/) and [Vue Components](https://vuejs.org), and is available as a free and open source project for any to use.
|
|
14
|
-
|
|
15
|
-
## Features
|
|
16
|
-
|
|
17
|
-
- **Multiple Frameworks**: Astro, Vue, and more with a unified usage pattern - use what suits your project best.
|
|
18
|
-
- **Intuitive**: Simple APIs, comprehensive documentation, and convenient integrations.
|
|
19
|
-
- **Accessible**: All components are WAI-ARIA compliant and include keyboard navigation, focus management, and
|
|
20
|
-
screen reader support.
|
|
21
|
-
- **Customizable**: Create your own design system by overriding styles and variants globally or per instance.
|
|
22
|
-
- **Performant**: Fully type-safe, SEO-friendly, modern and lean dependencies, and blazing fast.
|
|
23
|
-
|
|
24
|
-
For a complete list of available components, refer to the [documentation](https://rimelight.com/company/docs/packages/rimelight-ui/).
|
|
25
|
-
|
|
26
|
-
## Installation
|
|
27
|
-
|
|
28
|
-
To use Rimelight UI in an Astro project, you need to install the package and add the integration.
|
|
29
|
-
|
|
30
|
-
1. Install the package into your project:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
# vp
|
|
34
|
-
vp install @rimelight/ui
|
|
35
|
-
|
|
36
|
-
# npm
|
|
37
|
-
npm install @rimelight/ui
|
|
38
|
-
|
|
39
|
-
# pnpm
|
|
40
|
-
pnpm add @rimelight/ui
|
|
41
|
-
|
|
42
|
-
# yarn
|
|
43
|
-
yarn add @rimelight/ui
|
|
44
|
-
|
|
45
|
-
# deno
|
|
46
|
-
deno add npm:@rimelight/ui
|
|
47
|
-
|
|
48
|
-
# bun
|
|
49
|
-
bun add @rimelight/ui
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
2. Add the Rimelight UI Astro integration to your Astro configuration:
|
|
53
|
-
|
|
54
|
-
```typescript
|
|
55
|
-
// astro.config.ts
|
|
56
|
-
import { ui } from "@rimelight/ui/integrations"
|
|
57
|
-
import { defineConfig } from "astro/config"
|
|
58
|
-
|
|
59
|
-
export default defineConfig({
|
|
60
|
-
integrations: [
|
|
61
|
-
ui({
|
|
62
|
-
// Optional: Provide global UI overrides
|
|
63
|
-
ui: {
|
|
64
|
-
button: {
|
|
65
|
-
defaultVariants: { variant: "primary" }
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
})
|
|
69
|
-
]
|
|
70
|
-
})
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Usage
|
|
74
|
-
|
|
75
|
-
### Astro Components
|
|
76
|
-
|
|
77
|
-
```astro
|
|
78
|
-
// component.astro
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
import { RLAButton } from '@rimelight/ui/components/astro/RLAButton.astro';
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
<RLAButton label="Click Me" />
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Vue Components
|
|
88
|
-
|
|
89
|
-
```vue
|
|
90
|
-
// component.vue
|
|
91
|
-
|
|
92
|
-
<script setup lang="ts">
|
|
93
|
-
import { RLVButton } from "@rimelight/ui/components/vue/RLVButton.vue"
|
|
94
|
-
</script>
|
|
95
|
-
|
|
96
|
-
<template>
|
|
97
|
-
<RLVButton label="Click Me" />
|
|
98
|
-
</template>
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
For mixed usage please refer to the [Astro documentation on using front-end frameworks](https://docs.astro.build/en/guides/framework-components/).
|
|
102
|
-
|
|
103
|
-
You can add the FAQ section right toward the bottom of your README, typically just before the Contributing or Support sections.
|
|
104
|
-
|
|
105
|
-
Since GitHub and most Markdown viewers natively support the <details> and <summary> HTML tags, they will render as interactive accordion dropdowns, keeping your README clean and compact.
|
|
106
|
-
|
|
107
|
-
Here is the exact code block to drop into your Repository README:
|
|
108
|
-
|
|
109
|
-
Markdown
|
|
110
|
-
|
|
111
|
-
## Frequently Asked Questions
|
|
112
|
-
|
|
113
|
-
<details>
|
|
114
|
-
<summary><b>Is Rimelight UI free to use?</b></summary>
|
|
115
|
-
Yes. Rimelight UI is a completely free and open source package under the <a href="./LICENSE">MIT License</a>.
|
|
116
|
-
</details>
|
|
117
|
-
|
|
118
|
-
<details>
|
|
119
|
-
<summary><b>Can I use Rimelight UI without Astro?</b></summary>
|
|
120
|
-
For the time being, no. The library is strictly distributed as an Astro integration. However, in theory, it could be modularized enough to be usable as a Vite plugin, and we are open to contributions on this topic.
|
|
121
|
-
</details>
|
|
122
|
-
|
|
123
|
-
<details>
|
|
124
|
-
<summary><b>Are other front-end frameworks supported?</b></summary>
|
|
125
|
-
For the time being, no. The library currently only offers Astro and Vue components, but in theory could support other front-end frameworks, and we welcome community contributions to expand this.
|
|
126
|
-
</details>
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary><b>Is Rimelight UI customizable?</b></summary>
|
|
130
|
-
Yes. All components can have their styles overridden per slot and per variant, either globally via your <code>astro.config.ts</code> configuration or locally on an individual instance using the <code>ui</code> prop.
|
|
131
|
-
</details>
|
|
132
|
-
|
|
133
|
-
<details>
|
|
134
|
-
<summary><b>Is Rimelight UI accessible?</b></summary>
|
|
135
|
-
Yes. All components provide automatic ARIA attributes, keyboard navigation, focus management, and screen reader support out of the box.
|
|
136
|
-
</details>
|
|
137
|
-
|
|
138
|
-
## Useful Links
|
|
139
|
-
|
|
140
|
-
- [Starter Project](https://starter.rimelight.com)
|
|
141
|
-
- [Playground](https://playground.rimelight.com/ui)
|
|
142
|
-
- [Documentation](https://rimelight.com/company/docs/packages/rimelight-ui/)
|
|
143
|
-
- [Changelog](https://rimelight.com/company/docs/packages/rimelight-ui/changelog/)
|
|
144
|
-
|
|
145
|
-
## Contributing
|
|
146
|
-
|
|
147
|
-
We welcome contributions to this project and its documentation. If you are interested in contributing, please refer to our [contribution guidelines](https://rimelight.com/company/docs/contributing/).
|
|
148
|
-
|
|
149
|
-
If you would like to financially support this project, please consider [sponsoring us](https://rimelight.com/company/docs/contributing/sponsoring/).
|
|
150
|
-
|
|
151
|
-
## Support
|
|
152
|
-
|
|
153
|
-
If you have any questions or need assistance, please feel free to reach out to us at [support@rimelight.com](mailto:support@rimelight.com).
|
|
154
|
-
|
|
155
|
-
## License
|
|
156
|
-
|
|
157
|
-
MIT
|
|
1
|
+
# Rimelight UI (@rimelight/ui)
|
|
2
|
+
|
|
3
|
+
[](https://astro.build)
|
|
4
|
+
|
|
5
|
+
[](https://playground.rimelight.com/ui)
|
|
6
|
+
[](https://rimelight.com/company/docs/packages/rimelight-ui/)
|
|
7
|
+
|
|
8
|
+
[](https://www.npmjs.com/package/@rimelight/ui)
|
|
9
|
+
[](https://www.npmjs.com/package/@rimelight/ui)
|
|
10
|
+
[](https://npmx.dev/package/@rimelight/ui)
|
|
11
|
+
|
|
12
|
+
Rimelight UI is a comprehensive component library for [Astro](https://astro.build) websites used and maintained by [Rimelight Entertainment](https://rimelight.com).
|
|
13
|
+
It offers a suite of accessible and highly performant components as [Astro Components](https://docs.astro.build/basics/astro-components/) and [Vue Components](https://vuejs.org), and is available as a free and open source project for any to use.
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- **Multiple Frameworks**: Astro, Vue, and more with a unified usage pattern - use what suits your project best.
|
|
18
|
+
- **Intuitive**: Simple APIs, comprehensive documentation, and convenient integrations.
|
|
19
|
+
- **Accessible**: All components are WAI-ARIA compliant and include keyboard navigation, focus management, and
|
|
20
|
+
screen reader support.
|
|
21
|
+
- **Customizable**: Create your own design system by overriding styles and variants globally or per instance.
|
|
22
|
+
- **Performant**: Fully type-safe, SEO-friendly, modern and lean dependencies, and blazing fast.
|
|
23
|
+
|
|
24
|
+
For a complete list of available components, refer to the [documentation](https://rimelight.com/company/docs/packages/rimelight-ui/).
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
To use Rimelight UI in an Astro project, you need to install the package and add the integration.
|
|
29
|
+
|
|
30
|
+
1. Install the package into your project:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# vp
|
|
34
|
+
vp install @rimelight/ui
|
|
35
|
+
|
|
36
|
+
# npm
|
|
37
|
+
npm install @rimelight/ui
|
|
38
|
+
|
|
39
|
+
# pnpm
|
|
40
|
+
pnpm add @rimelight/ui
|
|
41
|
+
|
|
42
|
+
# yarn
|
|
43
|
+
yarn add @rimelight/ui
|
|
44
|
+
|
|
45
|
+
# deno
|
|
46
|
+
deno add npm:@rimelight/ui
|
|
47
|
+
|
|
48
|
+
# bun
|
|
49
|
+
bun add @rimelight/ui
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
2. Add the Rimelight UI Astro integration to your Astro configuration:
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
// astro.config.ts
|
|
56
|
+
import { ui } from "@rimelight/ui/integrations"
|
|
57
|
+
import { defineConfig } from "astro/config"
|
|
58
|
+
|
|
59
|
+
export default defineConfig({
|
|
60
|
+
integrations: [
|
|
61
|
+
ui({
|
|
62
|
+
// Optional: Provide global UI overrides
|
|
63
|
+
ui: {
|
|
64
|
+
button: {
|
|
65
|
+
defaultVariants: { variant: "primary" }
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
})
|
|
69
|
+
]
|
|
70
|
+
})
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Usage
|
|
74
|
+
|
|
75
|
+
### Astro Components
|
|
76
|
+
|
|
77
|
+
```astro
|
|
78
|
+
// component.astro
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
import { RLAButton } from '@rimelight/ui/components/astro/RLAButton.astro';
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
<RLAButton label="Click Me" />
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Vue Components
|
|
88
|
+
|
|
89
|
+
```vue
|
|
90
|
+
// component.vue
|
|
91
|
+
|
|
92
|
+
<script setup lang="ts">
|
|
93
|
+
import { RLVButton } from "@rimelight/ui/components/vue/RLVButton.vue"
|
|
94
|
+
</script>
|
|
95
|
+
|
|
96
|
+
<template>
|
|
97
|
+
<RLVButton label="Click Me" />
|
|
98
|
+
</template>
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
For mixed usage please refer to the [Astro documentation on using front-end frameworks](https://docs.astro.build/en/guides/framework-components/).
|
|
102
|
+
|
|
103
|
+
You can add the FAQ section right toward the bottom of your README, typically just before the Contributing or Support sections.
|
|
104
|
+
|
|
105
|
+
Since GitHub and most Markdown viewers natively support the <details> and <summary> HTML tags, they will render as interactive accordion dropdowns, keeping your README clean and compact.
|
|
106
|
+
|
|
107
|
+
Here is the exact code block to drop into your Repository README:
|
|
108
|
+
|
|
109
|
+
Markdown
|
|
110
|
+
|
|
111
|
+
## Frequently Asked Questions
|
|
112
|
+
|
|
113
|
+
<details>
|
|
114
|
+
<summary><b>Is Rimelight UI free to use?</b></summary>
|
|
115
|
+
Yes. Rimelight UI is a completely free and open source package under the <a href="./LICENSE">MIT License</a>.
|
|
116
|
+
</details>
|
|
117
|
+
|
|
118
|
+
<details>
|
|
119
|
+
<summary><b>Can I use Rimelight UI without Astro?</b></summary>
|
|
120
|
+
For the time being, no. The library is strictly distributed as an Astro integration. However, in theory, it could be modularized enough to be usable as a Vite plugin, and we are open to contributions on this topic.
|
|
121
|
+
</details>
|
|
122
|
+
|
|
123
|
+
<details>
|
|
124
|
+
<summary><b>Are other front-end frameworks supported?</b></summary>
|
|
125
|
+
For the time being, no. The library currently only offers Astro and Vue components, but in theory could support other front-end frameworks, and we welcome community contributions to expand this.
|
|
126
|
+
</details>
|
|
127
|
+
|
|
128
|
+
<details>
|
|
129
|
+
<summary><b>Is Rimelight UI customizable?</b></summary>
|
|
130
|
+
Yes. All components can have their styles overridden per slot and per variant, either globally via your <code>astro.config.ts</code> configuration or locally on an individual instance using the <code>ui</code> prop.
|
|
131
|
+
</details>
|
|
132
|
+
|
|
133
|
+
<details>
|
|
134
|
+
<summary><b>Is Rimelight UI accessible?</b></summary>
|
|
135
|
+
Yes. All components provide automatic ARIA attributes, keyboard navigation, focus management, and screen reader support out of the box.
|
|
136
|
+
</details>
|
|
137
|
+
|
|
138
|
+
## Useful Links
|
|
139
|
+
|
|
140
|
+
- [Starter Project](https://starter.rimelight.com)
|
|
141
|
+
- [Playground](https://playground.rimelight.com/ui)
|
|
142
|
+
- [Documentation](https://rimelight.com/company/docs/packages/rimelight-ui/)
|
|
143
|
+
- [Changelog](https://rimelight.com/company/docs/packages/rimelight-ui/changelog/)
|
|
144
|
+
|
|
145
|
+
## Contributing
|
|
146
|
+
|
|
147
|
+
We welcome contributions to this project and its documentation. If you are interested in contributing, please refer to our [contribution guidelines](https://rimelight.com/company/docs/contributing/).
|
|
148
|
+
|
|
149
|
+
If you would like to financially support this project, please consider [sponsoring us](https://rimelight.com/company/docs/contributing/sponsoring/).
|
|
150
|
+
|
|
151
|
+
## Support
|
|
152
|
+
|
|
153
|
+
If you have any questions or need assistance, please feel free to reach out to us at [support@rimelight.com](mailto:support@rimelight.com).
|
|
154
|
+
|
|
155
|
+
## License
|
|
156
|
+
|
|
157
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,105 +1,105 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@rimelight/ui",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"private": false,
|
|
5
|
-
"description": "Rimelight Entertainment UI Library.",
|
|
6
|
-
"keywords": [
|
|
7
|
-
"astro",
|
|
8
|
-
"typescript"
|
|
9
|
-
],
|
|
10
|
-
"homepage": "https://rimelight.com/docs",
|
|
11
|
-
"bugs": {
|
|
12
|
-
"url": "https://github.com/Rimelight-Entertainment/rimelight/issues"
|
|
13
|
-
},
|
|
14
|
-
"license": "MIT",
|
|
15
|
-
"author": {
|
|
16
|
-
"name": "Daniel Marchi"
|
|
17
|
-
},
|
|
18
|
-
"repository": {
|
|
19
|
-
"type": "git",
|
|
20
|
-
"url": "git+https://github.com/Rimelight-Entertainment/rimelight.git"
|
|
21
|
-
},
|
|
22
|
-
"files": [
|
|
23
|
-
"src",
|
|
24
|
-
"worker-configuration.d.ts",
|
|
25
|
-
"README.md",
|
|
26
|
-
"LICENSE"
|
|
27
|
-
],
|
|
28
|
-
"type": "module",
|
|
29
|
-
"exports": {
|
|
30
|
-
".": "./src/integrations/index.ts",
|
|
31
|
-
"./styles/*": "./src/styles/*",
|
|
32
|
-
"./components/*": "./src/components/*",
|
|
33
|
-
"./components/astro/*": "./src/components/astro/*",
|
|
34
|
-
"./components/vue/*": "./src/components/vue/*",
|
|
35
|
-
"./themes": "./src/themes/index.ts",
|
|
36
|
-
"./themes/*": "./src/themes/*",
|
|
37
|
-
"./composables": "./src/composables/index.ts",
|
|
38
|
-
"./composables/*": "./src/composables/*",
|
|
39
|
-
"./config": "./src/config/index.ts",
|
|
40
|
-
"./config/*": "./src/config/*",
|
|
41
|
-
"./utils": "./src/utils/index.ts",
|
|
42
|
-
"./utils/*": "./src/utils/*",
|
|
43
|
-
"./integrations": "./src/integrations/index.ts",
|
|
44
|
-
"./integrations/*": "./src/integrations/*",
|
|
45
|
-
"./plugins": "./src/plugins/index.ts",
|
|
46
|
-
"./plugins/*": "./src/plugins/*",
|
|
47
|
-
"./middleware": "./src/middleware/index.ts",
|
|
48
|
-
"./middleware/*": "./src/middleware/*",
|
|
49
|
-
"./types": "./src/types/index.ts",
|
|
50
|
-
"./types/*": "./src/types/*",
|
|
51
|
-
"./presets": "./src/presets/index.ts",
|
|
52
|
-
"./presets/*": "./src/presets/*",
|
|
53
|
-
"./*": "./src/*"
|
|
54
|
-
},
|
|
55
|
-
"publishConfig": {
|
|
56
|
-
"access": "public"
|
|
57
|
-
},
|
|
58
|
-
"scripts": {
|
|
59
|
-
"prepare": "vp config",
|
|
60
|
-
"knip": "knip",
|
|
61
|
-
"astro": "astro",
|
|
62
|
-
"docs:meta": "tsx scripts/extract-meta.ts"
|
|
63
|
-
},
|
|
64
|
-
"dependencies": {
|
|
65
|
-
"@astrojs/prism": "^4.0.2",
|
|
66
|
-
"@astrojs/vue": "7.0.0-alpha.0",
|
|
67
|
-
"
|
|
68
|
-
"@
|
|
69
|
-
"
|
|
70
|
-
"
|
|
71
|
-
"
|
|
72
|
-
"
|
|
73
|
-
"
|
|
74
|
-
"
|
|
75
|
-
"turndown": "^7.2.4",
|
|
76
|
-
"turndown-plugin-gfm": "^1.0.2",
|
|
77
|
-
"vite-plugin-virtual": "^0.5.0"
|
|
78
|
-
},
|
|
79
|
-
"devDependencies": {
|
|
80
|
-
"@astrojs/check": "0.9.9",
|
|
81
|
-
"@astrojs/ts-plugin": "1.10.9",
|
|
82
|
-
"@e18e/eslint-plugin": "0.5.0",
|
|
83
|
-
"@types/node": "25.9.1",
|
|
84
|
-
"@types/picomatch": "^4.0.3",
|
|
85
|
-
"@unocss/eslint-plugin": "66.7.0",
|
|
86
|
-
"astro": "7.0.0-alpha.0",
|
|
87
|
-
"eslint-plugin-regexp": "3.1.0",
|
|
88
|
-
"knip": "6.14.2",
|
|
89
|
-
"tsx": "4.22.3",
|
|
90
|
-
"typescript": "6.0.3",
|
|
91
|
-
"unocss": "66.7.0",
|
|
92
|
-
"vite-plus": "catalog:"
|
|
93
|
-
},
|
|
94
|
-
"peerDependencies": {
|
|
95
|
-
"@astrojs/starlight": ">=0.5.0",
|
|
96
|
-
"astro": ">=6.0.0",
|
|
97
|
-
"vue": ">=3.4.0"
|
|
98
|
-
},
|
|
99
|
-
"peerDependenciesMeta": {
|
|
100
|
-
"vue": {
|
|
101
|
-
"optional": true
|
|
102
|
-
}
|
|
103
|
-
},
|
|
104
|
-
"packageManager": "pnpm@11.3.0"
|
|
105
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@rimelight/ui",
|
|
3
|
+
"version": "0.0.34",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "Rimelight Entertainment UI Library.",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"astro",
|
|
8
|
+
"typescript"
|
|
9
|
+
],
|
|
10
|
+
"homepage": "https://rimelight.com/docs",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/Rimelight-Entertainment/rimelight/issues"
|
|
13
|
+
},
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"author": {
|
|
16
|
+
"name": "Daniel Marchi"
|
|
17
|
+
},
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/Rimelight-Entertainment/rimelight.git"
|
|
21
|
+
},
|
|
22
|
+
"files": [
|
|
23
|
+
"src",
|
|
24
|
+
"worker-configuration.d.ts",
|
|
25
|
+
"README.md",
|
|
26
|
+
"LICENSE"
|
|
27
|
+
],
|
|
28
|
+
"type": "module",
|
|
29
|
+
"exports": {
|
|
30
|
+
".": "./src/integrations/index.ts",
|
|
31
|
+
"./styles/*": "./src/styles/*",
|
|
32
|
+
"./components/*": "./src/components/*",
|
|
33
|
+
"./components/astro/*": "./src/components/astro/*",
|
|
34
|
+
"./components/vue/*": "./src/components/vue/*",
|
|
35
|
+
"./themes": "./src/themes/index.ts",
|
|
36
|
+
"./themes/*": "./src/themes/*",
|
|
37
|
+
"./composables": "./src/composables/index.ts",
|
|
38
|
+
"./composables/*": "./src/composables/*",
|
|
39
|
+
"./config": "./src/config/index.ts",
|
|
40
|
+
"./config/*": "./src/config/*",
|
|
41
|
+
"./utils": "./src/utils/index.ts",
|
|
42
|
+
"./utils/*": "./src/utils/*",
|
|
43
|
+
"./integrations": "./src/integrations/index.ts",
|
|
44
|
+
"./integrations/*": "./src/integrations/*",
|
|
45
|
+
"./plugins": "./src/plugins/index.ts",
|
|
46
|
+
"./plugins/*": "./src/plugins/*",
|
|
47
|
+
"./middleware": "./src/middleware/index.ts",
|
|
48
|
+
"./middleware/*": "./src/middleware/*",
|
|
49
|
+
"./types": "./src/types/index.ts",
|
|
50
|
+
"./types/*": "./src/types/*",
|
|
51
|
+
"./presets": "./src/presets/index.ts",
|
|
52
|
+
"./presets/*": "./src/presets/*",
|
|
53
|
+
"./*": "./src/*"
|
|
54
|
+
},
|
|
55
|
+
"publishConfig": {
|
|
56
|
+
"access": "public"
|
|
57
|
+
},
|
|
58
|
+
"scripts": {
|
|
59
|
+
"prepare": "vp config",
|
|
60
|
+
"knip": "knip",
|
|
61
|
+
"astro": "astro",
|
|
62
|
+
"docs:meta": "tsx scripts/extract-meta.ts"
|
|
63
|
+
},
|
|
64
|
+
"dependencies": {
|
|
65
|
+
"@astrojs/prism": "^4.0.2",
|
|
66
|
+
"@astrojs/vue": "7.0.0-alpha.0",
|
|
67
|
+
"@iconify-json/lucide": "^1.2.109",
|
|
68
|
+
"@unocss/astro": "^66.7.0",
|
|
69
|
+
"css-variants": "2.3.5",
|
|
70
|
+
"defu": "6.1.7",
|
|
71
|
+
"embla-carousel": "8.6.0",
|
|
72
|
+
"nanostores": "1.3.0",
|
|
73
|
+
"picomatch": "^4.0.4",
|
|
74
|
+
"prismjs": "^1.29.0",
|
|
75
|
+
"turndown": "^7.2.4",
|
|
76
|
+
"turndown-plugin-gfm": "^1.0.2",
|
|
77
|
+
"vite-plugin-virtual": "^0.5.0"
|
|
78
|
+
},
|
|
79
|
+
"devDependencies": {
|
|
80
|
+
"@astrojs/check": "0.9.9",
|
|
81
|
+
"@astrojs/ts-plugin": "1.10.9",
|
|
82
|
+
"@e18e/eslint-plugin": "0.5.0",
|
|
83
|
+
"@types/node": "25.9.1",
|
|
84
|
+
"@types/picomatch": "^4.0.3",
|
|
85
|
+
"@unocss/eslint-plugin": "66.7.0",
|
|
86
|
+
"astro": "7.0.0-alpha.0",
|
|
87
|
+
"eslint-plugin-regexp": "3.1.0",
|
|
88
|
+
"knip": "6.14.2",
|
|
89
|
+
"tsx": "4.22.3",
|
|
90
|
+
"typescript": "6.0.3",
|
|
91
|
+
"unocss": "66.7.0",
|
|
92
|
+
"vite-plus": "catalog:"
|
|
93
|
+
},
|
|
94
|
+
"peerDependencies": {
|
|
95
|
+
"@astrojs/starlight": ">=0.5.0",
|
|
96
|
+
"astro": ">=6.0.0",
|
|
97
|
+
"vue": ">=3.4.0"
|
|
98
|
+
},
|
|
99
|
+
"peerDependenciesMeta": {
|
|
100
|
+
"vue": {
|
|
101
|
+
"optional": true
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"packageManager": "pnpm@11.3.0"
|
|
105
|
+
}
|
|
@@ -18,9 +18,9 @@ const {
|
|
|
18
18
|
} = Astro.props as AspectRatioProps
|
|
19
19
|
|
|
20
20
|
const classes = resolveClasses(aspectRatio, {}, useUi("aspectRatio", uiProp), className)
|
|
21
|
-
const paddingBottom = `${(1 / ratio) * 100}%`
|
|
22
21
|
---
|
|
23
|
-
<div class={classes.root} data-slot="root"
|
|
22
|
+
<div class:list={[classes.root]} data-slot="root" {...rest}>
|
|
23
|
+
<svg viewBox={`0 0 100 ${(1 / ratio) * 100}`} class="w-full h-auto pointer-events-none block" aria-hidden="true"></svg>
|
|
24
24
|
<div class={classes.content} data-slot="content">
|
|
25
25
|
<slot />
|
|
26
26
|
</div>
|