@csedl/svelte-on-rails 0.0.1 → 0.0.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 (2) hide show
  1. package/README.md +5 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,11 @@
1
1
  # @csedl/svelte-on-rails
2
2
 
3
- It picks up svelte components rendered by [svelte-on-rails](https://gitlab.com/sedl/svelte-on-rails) rails gem and hydrates them.
3
+ Works together with the [svelte-on-rails](https://gitlab.com/sedl/svelte-on-rails) gem.
4
4
 
5
5
  ## Installation
6
6
 
7
+ First, you must have svelte and the gem running on your project, please follow the [gem](https://gitlab.com/sedl/svelte-on-rails) instructions.
8
+
7
9
  ```
8
10
  npm i @csedl/svelte-on-rails
9
11
  ```
@@ -52,11 +54,13 @@ to the wrapping element. Then, this lib
52
54
  - removes the `data-not-hydrated-svelte-component` attribute (in case of SSR)
53
55
  - adds the attribute `data-svelte-hydrated='true'`
54
56
  - as custom element:
57
+ - builds custom elements withoud `shadow-dom` so that global styles can be applied to the element
55
58
  - adds the attribute `data-custom-element-initialized="my-component-file-name-svelte"`
56
59
 
57
60
  ## Requirements
58
61
 
59
62
  - Svelte >= 5
63
+ - tested with ruby 3.2.2 and rails 7.1
60
64
 
61
65
  ## Testing
62
66
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@csedl/svelte-on-rails",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Hydrates svelte components and handles svelte custom elements without shadow-dom, that are rendered from ruby-gem svelte-on-rails.",
5
5
  "main": "index.js",
6
6
  "exports": {