@molecule/app-rating-form-svelte 0.0.0-stage → 1.1.0
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/LICENSE +202 -0
- package/README.md +114 -2
- package/dist/RatingForm.svelte +126 -0
- package/dist/RatingForm.svelte.d.ts +5 -0
- package/dist/RatingForm.svelte.d.ts.map +1 -0
- package/dist/components.d.ts +8 -0
- package/dist/components.d.ts.map +1 -0
- package/dist/components.js +7 -0
- package/dist/index.d.ts +37 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +36 -0
- package/dist/star-style.d.ts +19 -0
- package/dist/star-style.d.ts.map +1 -0
- package/dist/star-style.js +30 -0
- package/dist/types.d.ts +30 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +6 -0
- package/package.json +71 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,115 @@
|
|
|
1
|
-
|
|
1
|
+
<!--
|
|
2
|
+
AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
3
|
+
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
|
+
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
|
+
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
+
Generated: 2026-11-15T09:56:51.763Z
|
|
7
|
+
-->
|
|
2
8
|
|
|
3
|
-
|
|
9
|
+
# @molecule/app-rating-form-svelte
|
|
10
|
+
|
|
11
|
+
Svelte interactive star-rating + comment form.
|
|
12
|
+
|
|
13
|
+
Exports `RatingForm` — a star radiogroup, a comment textarea and a submit
|
|
14
|
+
button. It is the Svelte counterpart of `@molecule/app-rating-form-react`:
|
|
15
|
+
same props (React names) and the same DOM for the same input.
|
|
16
|
+
|
|
17
|
+
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
18
|
+
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
19
|
+
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
```svelte
|
|
24
|
+
<script lang="ts">
|
|
25
|
+
import { RatingForm } from '@molecule/app-rating-form-svelte'
|
|
26
|
+
|
|
27
|
+
async function submitReview(rating: number, comment: string): Promise<void> {
|
|
28
|
+
await fetch('/api/reviews', { method: 'POST', body: JSON.stringify({ rating, comment }) })
|
|
29
|
+
}
|
|
30
|
+
</script>
|
|
31
|
+
|
|
32
|
+
<RatingForm
|
|
33
|
+
title="Leave a review"
|
|
34
|
+
onSubmit={submitReview}
|
|
35
|
+
requireComment={false}
|
|
36
|
+
submitLabel="Submit review"
|
|
37
|
+
/>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Type
|
|
41
|
+
|
|
42
|
+
`feature`
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm install @molecule/app-rating-form-svelte @molecule/app-svelte @molecule/app-ui @molecule/app-ui-svelte svelte
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## API
|
|
51
|
+
|
|
52
|
+
### Interfaces
|
|
53
|
+
|
|
54
|
+
#### `RatingFormProps`
|
|
55
|
+
|
|
56
|
+
Props accepted by {@link RatingForm} — the same props (React names) as
|
|
57
|
+
`@molecule/app-rating-form-react`, with node-valued props as snippets (or
|
|
58
|
+
plain strings).
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
interface RatingFormProps {
|
|
62
|
+
/** Called with the submitted rating + optional comment. */
|
|
63
|
+
onSubmit: (rating: number, comment: string) => void | Promise<void>
|
|
64
|
+
/** Maximum stars. Defaults to 5. */
|
|
65
|
+
max?: number
|
|
66
|
+
/** Initial rating (uncontrolled). */
|
|
67
|
+
defaultRating?: number
|
|
68
|
+
/** Whether a comment is required. Defaults to false. */
|
|
69
|
+
requireComment?: boolean
|
|
70
|
+
/** Form heading — a snippet or a plain string. */
|
|
71
|
+
title?: Snippet | string
|
|
72
|
+
/** Comment placeholder. */
|
|
73
|
+
commentPlaceholder?: string
|
|
74
|
+
/** Submit-button label — a snippet or a plain string. */
|
|
75
|
+
submitLabel?: Snippet | string
|
|
76
|
+
/** Extra classes. */
|
|
77
|
+
className?: string
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Constants
|
|
82
|
+
|
|
83
|
+
#### `RatingForm`
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
const RatingForm: LegacyComponentType
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Injection Notes
|
|
90
|
+
|
|
91
|
+
### Requirements
|
|
92
|
+
|
|
93
|
+
Peer dependencies:
|
|
94
|
+
|
|
95
|
+
- `@molecule/app-svelte` ^3.5.0
|
|
96
|
+
- `@molecule/app-ui` ^1.0.1
|
|
97
|
+
- `@molecule/app-ui-svelte` ^1.1.0
|
|
98
|
+
- `svelte` ^5.0.0
|
|
99
|
+
|
|
100
|
+
### Runtime Dependencies
|
|
101
|
+
|
|
102
|
+
- `@molecule/app-svelte`
|
|
103
|
+
- `@molecule/app-ui`
|
|
104
|
+
- `@molecule/app-ui-svelte`
|
|
105
|
+
- `svelte`
|
|
106
|
+
|
|
107
|
+
Companion locale bond: `@molecule/app-locales-rating-form`. The submit button
|
|
108
|
+
stays disabled until a star rating is selected, and `requireComment` blocks
|
|
109
|
+
submission on blank comments silently (no inline error is rendered). Rejected
|
|
110
|
+
`onSubmit` promises propagate — handle errors in your handler. Requires a
|
|
111
|
+
bonded ClassMap and `@molecule/app-svelte`'s i18n provider above it.
|
|
112
|
+
|
|
113
|
+
## Translations
|
|
114
|
+
|
|
115
|
+
Translation strings are provided by `@molecule/app-locales-rating-form`.
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
RatingForm: the Svelte counterpart of `@molecule/app-rating-form-react`'s
|
|
3
|
+
`RatingForm` — a star radiogroup, a comment textarea and a submit button,
|
|
4
|
+
tracking its own hover / submitting state. Same props, same DOM for the same
|
|
5
|
+
input; node props are snippets (or plain strings) and every visible string
|
|
6
|
+
goes through `t()` so a locale switch re-renders it.
|
|
7
|
+
|
|
8
|
+
The `svelte-ignore` lines below mark two deliberate trade-offs React's package
|
|
9
|
+
documents: `rating` captures the initial `defaultRating` prop value once (a
|
|
10
|
+
later prop write must not move the selection), and the radiogroup `<div>`
|
|
11
|
+
carries no `tabindex` — React renders none, and the star `<button>`s are the
|
|
12
|
+
focusable controls, so adding one would change the DOM this package must
|
|
13
|
+
reproduce exactly.
|
|
14
|
+
-->
|
|
15
|
+
<script lang="ts">
|
|
16
|
+
import { useTranslation } from '@molecule/app-svelte'
|
|
17
|
+
import { getClassMap } from '@molecule/app-ui'
|
|
18
|
+
import { Button, Textarea } from '@molecule/app-ui-svelte'
|
|
19
|
+
|
|
20
|
+
import { starStyle } from './star-style.js'
|
|
21
|
+
import type { RatingFormProps } from './types.js'
|
|
22
|
+
|
|
23
|
+
let {
|
|
24
|
+
onSubmit,
|
|
25
|
+
max = 5,
|
|
26
|
+
defaultRating = 0,
|
|
27
|
+
requireComment,
|
|
28
|
+
title,
|
|
29
|
+
commentPlaceholder,
|
|
30
|
+
submitLabel,
|
|
31
|
+
className,
|
|
32
|
+
}: RatingFormProps = $props()
|
|
33
|
+
|
|
34
|
+
const cm = $derived(getClassMap())
|
|
35
|
+
const { t } = useTranslation()
|
|
36
|
+
|
|
37
|
+
// svelte-ignore state_referenced_locally
|
|
38
|
+
// React's useState seeds the rating from the `defaultRating` PROP VALUE once
|
|
39
|
+
// (a later prop write never moves the selection), so capturing the initial
|
|
40
|
+
// value is the point, not an oversight.
|
|
41
|
+
let rating = $state(defaultRating)
|
|
42
|
+
let hover = $state(0)
|
|
43
|
+
let comment = $state('')
|
|
44
|
+
let submitting = $state(false)
|
|
45
|
+
|
|
46
|
+
const display = $derived(hover || rating)
|
|
47
|
+
const stars = $derived(Array.from({ length: max }, (_value, index) => index + 1))
|
|
48
|
+
|
|
49
|
+
// Every `t(…)` runs inside a `$derived`: it reads the i18n version under the
|
|
50
|
+
// hood, so these re-run on a locale switch the way React's render-time `t`
|
|
51
|
+
// calls re-run on a re-render.
|
|
52
|
+
const ratingLabel = $derived(t('rating.label', {}, { defaultValue: 'Rating' }))
|
|
53
|
+
const placeholderText = $derived(
|
|
54
|
+
commentPlaceholder ??
|
|
55
|
+
t('rating.commentPlaceholder', {}, { defaultValue: 'Share your thoughts (optional)' }),
|
|
56
|
+
)
|
|
57
|
+
const submittingText = $derived(t('rating.submitting', {}, { defaultValue: 'Submitting…' }))
|
|
58
|
+
const submitText = $derived(t('rating.submit', {}, { defaultValue: 'Submit review' }))
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Handles form submission: validates state, delegates to onSubmit, and
|
|
62
|
+
* manages the submitting flag (React's `handle`).
|
|
63
|
+
*
|
|
64
|
+
* @param event - The submit event.
|
|
65
|
+
*/
|
|
66
|
+
async function handle(event: SubmitEvent): Promise<void> {
|
|
67
|
+
event.preventDefault()
|
|
68
|
+
if (submitting || !rating) return
|
|
69
|
+
if (requireComment && !comment.trim()) return
|
|
70
|
+
submitting = true
|
|
71
|
+
try {
|
|
72
|
+
await onSubmit(rating, comment)
|
|
73
|
+
} finally {
|
|
74
|
+
submitting = false
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
</script>
|
|
78
|
+
|
|
79
|
+
<form class={cm.cn(cm.stack(3), className)} onsubmit={handle}>
|
|
80
|
+
{#if title}
|
|
81
|
+
<h3 class={cm.cn(cm.textSize('base'), cm.fontWeight('semibold'))}>
|
|
82
|
+
{#if typeof title === 'function'}{@render title()}{:else}{title}{/if}
|
|
83
|
+
</h3>
|
|
84
|
+
{/if}
|
|
85
|
+
<!-- svelte-ignore a11y_interactive_supports_focus -->
|
|
86
|
+
<div
|
|
87
|
+
role="radiogroup"
|
|
88
|
+
aria-label={ratingLabel}
|
|
89
|
+
class={cm.flex({ align: 'center', gap: 'xs' })}
|
|
90
|
+
onmouseleave={() => (hover = 0)}
|
|
91
|
+
>
|
|
92
|
+
{#each stars as n (n)}
|
|
93
|
+
<button
|
|
94
|
+
type="button"
|
|
95
|
+
role="radio"
|
|
96
|
+
data-mol-id="rating-form-star"
|
|
97
|
+
aria-checked={rating === n}
|
|
98
|
+
aria-label={t('rating.star', { n, max }, { defaultValue: '{{n}} of {{max}}' })}
|
|
99
|
+
onclick={() => (rating = n)}
|
|
100
|
+
onmouseenter={() => (hover = n)}
|
|
101
|
+
class={cm.cn(cm.cursorPointer, cm.touchTarget)}
|
|
102
|
+
use:starStyle={n <= display}
|
|
103
|
+
>
|
|
104
|
+
★
|
|
105
|
+
</button>
|
|
106
|
+
{/each}
|
|
107
|
+
</div>
|
|
108
|
+
<Textarea
|
|
109
|
+
value={comment}
|
|
110
|
+
onChange={(event: Event) => (comment = (event.target as HTMLTextAreaElement).value)}
|
|
111
|
+
placeholder={placeholderText}
|
|
112
|
+
rows={4}
|
|
113
|
+
aria-label="Comment"
|
|
114
|
+
/>
|
|
115
|
+
<Button type="submit" variant="solid" color="primary" disabled={submitting || !rating}>
|
|
116
|
+
{#if submitting}
|
|
117
|
+
{submittingText}
|
|
118
|
+
{:else if typeof submitLabel === 'function'}
|
|
119
|
+
{@render submitLabel()}
|
|
120
|
+
{:else if submitLabel !== undefined && submitLabel !== null}
|
|
121
|
+
{submitLabel}
|
|
122
|
+
{:else}
|
|
123
|
+
{submitText}
|
|
124
|
+
{/if}
|
|
125
|
+
</Button>
|
|
126
|
+
</form>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RatingForm.svelte.d.ts","sourceRoot":"","sources":["../src/RatingForm.svelte"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAiGlD,QAAA,MAAM,UAAU,qDAAwC,CAAC;AACzD,KAAK,UAAU,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AAChD,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The package's components: one Svelte 5 component per React component in
|
|
3
|
+
* `@molecule/app-rating-form-react`, under the same React name.
|
|
4
|
+
*
|
|
5
|
+
* @module
|
|
6
|
+
*/
|
|
7
|
+
export { default as RatingForm } from './RatingForm.svelte';
|
|
8
|
+
//# sourceMappingURL=components.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../src/components.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAA"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Svelte interactive star-rating + comment form.
|
|
3
|
+
*
|
|
4
|
+
* Exports `RatingForm` — a star radiogroup, a comment textarea and a submit
|
|
5
|
+
* button. It is the Svelte counterpart of `@molecule/app-rating-form-react`:
|
|
6
|
+
* same props (React names) and the same DOM for the same input.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```svelte
|
|
10
|
+
* <script lang="ts">
|
|
11
|
+
* import { RatingForm } from '@molecule/app-rating-form-svelte'
|
|
12
|
+
*
|
|
13
|
+
* async function submitReview(rating: number, comment: string): Promise<void> {
|
|
14
|
+
* await fetch('/api/reviews', { method: 'POST', body: JSON.stringify({ rating, comment }) })
|
|
15
|
+
* }
|
|
16
|
+
* </script>
|
|
17
|
+
*
|
|
18
|
+
* <RatingForm
|
|
19
|
+
* title="Leave a review"
|
|
20
|
+
* onSubmit={submitReview}
|
|
21
|
+
* requireComment={false}
|
|
22
|
+
* submitLabel="Submit review"
|
|
23
|
+
* />
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* Companion locale bond: `@molecule/app-locales-rating-form`. The submit button
|
|
28
|
+
* stays disabled until a star rating is selected, and `requireComment` blocks
|
|
29
|
+
* submission on blank comments silently (no inline error is rendered). Rejected
|
|
30
|
+
* `onSubmit` promises propagate — handle errors in your handler. Requires a
|
|
31
|
+
* bonded ClassMap and `@molecule/app-svelte`'s i18n provider above it.
|
|
32
|
+
*
|
|
33
|
+
* @module
|
|
34
|
+
*/
|
|
35
|
+
export * from './components.js';
|
|
36
|
+
export * from './types.js';
|
|
37
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Svelte interactive star-rating + comment form.
|
|
3
|
+
*
|
|
4
|
+
* Exports `RatingForm` — a star radiogroup, a comment textarea and a submit
|
|
5
|
+
* button. It is the Svelte counterpart of `@molecule/app-rating-form-react`:
|
|
6
|
+
* same props (React names) and the same DOM for the same input.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```svelte
|
|
10
|
+
* <script lang="ts">
|
|
11
|
+
* import { RatingForm } from '@molecule/app-rating-form-svelte'
|
|
12
|
+
*
|
|
13
|
+
* async function submitReview(rating: number, comment: string): Promise<void> {
|
|
14
|
+
* await fetch('/api/reviews', { method: 'POST', body: JSON.stringify({ rating, comment }) })
|
|
15
|
+
* }
|
|
16
|
+
* </script>
|
|
17
|
+
*
|
|
18
|
+
* <RatingForm
|
|
19
|
+
* title="Leave a review"
|
|
20
|
+
* onSubmit={submitReview}
|
|
21
|
+
* requireComment={false}
|
|
22
|
+
* submitLabel="Submit review"
|
|
23
|
+
* />
|
|
24
|
+
* ```
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* Companion locale bond: `@molecule/app-locales-rating-form`. The submit button
|
|
28
|
+
* stays disabled until a star rating is selected, and `requireComment` blocks
|
|
29
|
+
* submission on blank comments silently (no inline error is rendered). Rejected
|
|
30
|
+
* `onSubmit` promises propagate — handle errors in your handler. Requires a
|
|
31
|
+
* bonded ClassMap and `@molecule/app-svelte`'s i18n provider above it.
|
|
32
|
+
*
|
|
33
|
+
* @module
|
|
34
|
+
*/
|
|
35
|
+
export * from './components.js';
|
|
36
|
+
export * from './types.js';
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The star button's inline style, applied the way react-dom applies it.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Applies the star button's four declarations through the CSSOM property
|
|
8
|
+
* setters (as react-dom does) instead of a `style` attribute string: cssstyle
|
|
9
|
+
* — jsdom's CSS engine — drops `background: none` when it parses a full
|
|
10
|
+
* declaration list, so a raw attribute would serialize differently from React.
|
|
11
|
+
*
|
|
12
|
+
* @param node - The star's `<button>`.
|
|
13
|
+
* @param filled - Whether the star draws in the filled colour.
|
|
14
|
+
* @returns The action, whose `update` re-applies on a fill change.
|
|
15
|
+
*/
|
|
16
|
+
export declare function starStyle(node: HTMLElement, filled: boolean): {
|
|
17
|
+
update: (next: boolean) => void;
|
|
18
|
+
};
|
|
19
|
+
//# sourceMappingURL=star-style.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"star-style.d.ts","sourceRoot":"","sources":["../src/star-style.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,GAAG;IAAE,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAA;CAAE,CASjG"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The star button's inline style, applied the way react-dom applies it.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/** The colours a star draws in, filled or empty. */
|
|
7
|
+
const STAR_COLORS = {
|
|
8
|
+
filled: 'var(--mol-color-warning, #facc15)',
|
|
9
|
+
empty: 'var(--mol-color-border, rgba(128,128,128,0.4))',
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* Applies the star button's four declarations through the CSSOM property
|
|
13
|
+
* setters (as react-dom does) instead of a `style` attribute string: cssstyle
|
|
14
|
+
* — jsdom's CSS engine — drops `background: none` when it parses a full
|
|
15
|
+
* declaration list, so a raw attribute would serialize differently from React.
|
|
16
|
+
*
|
|
17
|
+
* @param node - The star's `<button>`.
|
|
18
|
+
* @param filled - Whether the star draws in the filled colour.
|
|
19
|
+
* @returns The action, whose `update` re-applies on a fill change.
|
|
20
|
+
*/
|
|
21
|
+
export function starStyle(node, filled) {
|
|
22
|
+
const apply = (on) => {
|
|
23
|
+
node.style.setProperty('background', 'none');
|
|
24
|
+
node.style.setProperty('border', 'none');
|
|
25
|
+
node.style.setProperty('font-size', '28px');
|
|
26
|
+
node.style.setProperty('color', on ? STAR_COLORS.filled : STAR_COLORS.empty);
|
|
27
|
+
};
|
|
28
|
+
apply(filled);
|
|
29
|
+
return { update: apply };
|
|
30
|
+
}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Types for the Svelte star-rating + comment form.
|
|
3
|
+
*
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
import type { Snippet } from 'svelte';
|
|
7
|
+
/**
|
|
8
|
+
* Props accepted by {@link RatingForm} — the same props (React names) as
|
|
9
|
+
* `@molecule/app-rating-form-react`, with node-valued props as snippets (or
|
|
10
|
+
* plain strings).
|
|
11
|
+
*/
|
|
12
|
+
export interface RatingFormProps {
|
|
13
|
+
/** Called with the submitted rating + optional comment. */
|
|
14
|
+
onSubmit: (rating: number, comment: string) => void | Promise<void>;
|
|
15
|
+
/** Maximum stars. Defaults to 5. */
|
|
16
|
+
max?: number;
|
|
17
|
+
/** Initial rating (uncontrolled). */
|
|
18
|
+
defaultRating?: number;
|
|
19
|
+
/** Whether a comment is required. Defaults to false. */
|
|
20
|
+
requireComment?: boolean;
|
|
21
|
+
/** Form heading — a snippet or a plain string. */
|
|
22
|
+
title?: Snippet | string;
|
|
23
|
+
/** Comment placeholder. */
|
|
24
|
+
commentPlaceholder?: string;
|
|
25
|
+
/** Submit-button label — a snippet or a plain string. */
|
|
26
|
+
submitLabel?: Snippet | string;
|
|
27
|
+
/** Extra classes. */
|
|
28
|
+
className?: string;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAErC;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,2DAA2D;IAC3D,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnE,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wDAAwD;IACxD,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,kDAAkD;IAClD,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IACxB,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC9B,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
|
package/dist/types.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,73 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@molecule/app-rating-form-svelte",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"description": "Interactive star rating + textarea + submit form for collecting reviews",
|
|
5
|
+
"homepage": "https://www.molecule.dev/packages/app-rating-form-svelte",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"svelte": "./dist/index.js",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
},
|
|
15
|
+
"./package.json": "./package.json"
|
|
16
|
+
},
|
|
17
|
+
"svelte": "./dist/index.js",
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"!dist/**/__tests__",
|
|
21
|
+
"!dist/**/*.test.*",
|
|
22
|
+
"!dist/**/*.spec.*",
|
|
23
|
+
"README.md"
|
|
24
|
+
],
|
|
25
|
+
"scripts": {
|
|
26
|
+
"build": "svelte-check --tsconfig ./tsconfig.json --fail-on-warnings && svelte-package --input src --output dist --tsconfig ./tsconfig.json",
|
|
27
|
+
"dev": "svelte-package --input src --output dist --tsconfig ./tsconfig.json --watch",
|
|
28
|
+
"test": "vitest run",
|
|
29
|
+
"test:watch": "vitest"
|
|
30
|
+
},
|
|
31
|
+
"keywords": [
|
|
32
|
+
"molecule",
|
|
33
|
+
"rating-form",
|
|
34
|
+
"svelte"
|
|
35
|
+
],
|
|
36
|
+
"author": "Molecule Dev, Inc. (https://molecule.dev)",
|
|
37
|
+
"license": "Apache-2.0",
|
|
38
|
+
"repository": {
|
|
39
|
+
"type": "git",
|
|
40
|
+
"url": "https://github.com/molecule-dev/molecule.git",
|
|
41
|
+
"directory": "packages/app/features/rating-form-svelte"
|
|
42
|
+
},
|
|
43
|
+
"engines": {
|
|
44
|
+
"node": ">=20"
|
|
45
|
+
},
|
|
46
|
+
"bugs": "https://github.com/molecule-dev/molecule/issues",
|
|
47
|
+
"publishConfig": {
|
|
48
|
+
"access": "public"
|
|
49
|
+
},
|
|
50
|
+
"peerDependencies": {
|
|
51
|
+
"@molecule/app-svelte": "^3.5.0",
|
|
52
|
+
"@molecule/app-ui": "^1.0.1",
|
|
53
|
+
"@molecule/app-ui-svelte": "^1.1.0",
|
|
54
|
+
"svelte": "^5.0.0"
|
|
55
|
+
},
|
|
56
|
+
"devDependencies": {
|
|
57
|
+
"@molecule/app-framework-conformance": "0.0.0",
|
|
58
|
+
"@molecule/app-i18n": "1.2.2",
|
|
59
|
+
"@molecule/app-icons": "1.0.4",
|
|
60
|
+
"@molecule/app-svelte": "3.7.1",
|
|
61
|
+
"@molecule/app-ui": "1.4.0",
|
|
62
|
+
"@molecule/app-ui-svelte": "1.1.5",
|
|
63
|
+
"@sveltejs/package": "3.0.2",
|
|
64
|
+
"@sveltejs/vite-plugin-svelte": "7.1.2",
|
|
65
|
+
"@types/node": "26.6.5",
|
|
66
|
+
"jsdom": "30.1.3",
|
|
67
|
+
"svelte": "5.57.2",
|
|
68
|
+
"svelte-check": "4.7.7",
|
|
69
|
+
"typescript": "6.0.3",
|
|
70
|
+
"vite": "8.3.5",
|
|
71
|
+
"vitest": "4.1.12"
|
|
72
|
+
}
|
|
73
|
+
}
|