phoenix_duskmoon 4.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Jonathan Gao
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# PhoenixDuskmoon
+
+[![release](https://github.com/gsmlg-dev/phoenix-duskmoon-ui/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/gsmlg-dev/phoenix-duskmoon-ui/actions/workflows/test-and-release.yml)
+
+Collection of helpers to generate and manipulate Web Component.
+
+Although this project was originally extracted from Phoenix,
+it does not depend on Phoenix and can be used with any Plug
+application (or even without Plug).
+
+See the [docs](https://hexdocs.pm/phoenix_duskmoon/) for more information.
+
+About at [Web Component](https://developer.mozilla.org/en-US/docs/Web/Web_Components)
+
+## Install
+
+Add deps in `mix.exs`
+```elixir
+    {:phoenix_duskmoon, "~> 3.0"},
+```
+
+Include in phoenix view helpers
+
+```elixir
+ defp html_helpers do
+    quote do
+        # import all helper functions
+        use PhoenixDuskmoon
+
+        # or 
+        use PhoenixDuskmoon, :alias
+        ...
+    end
+end
+```
+
+Include `javascript`
+
+```javascript
+import 'phoenix_duskmoon';
+```
+
+Web Componet library is now external
+
+```bash
+npm install @gsmlg/lit
+```
+
+Import `css`
+
+```css
+@import 'phoenix_duskmoon/priv/static/phoenix_duskmoon.css';
+```
+
+Use custom hook
+
+```javascript
+import "phoenix_duskmoon";
+const WebComponentHook = window.__WebComponentHook__;
+const liveSocket = new LiveSocket("/live", Socket, {hooks: { WebComponentHook }});
+```
+
+Send custom events to live view:
+```html
+<Element darkmoon-send-sync-content="load_content" phx-hook="WebComponentHook" />
+<Element darkmoon-send-sync-content="load_content;loadAccepted" phx-hook="WebComponentHook" />
+```
+- In the first element, when element trigger customEvents `sync-content`, also use `pushEvent` send `load_content` to live view.
+- Second element are same as first, but will call `loadAccepted` on element when receive server send feedback.
+
+Receive live view event:
+```html
+<Element darkmoon-receive-update_content="updateContent" phx-hook="WebComponentHook" />
+<!-- equal  -->
+<Element darkmoon-receive="update_content;updateContent" phx-hook="WebComponentHook" />
+```
+- In this case, when live view fire `update_content` event, also trigger `updateContent` method on elmenet.
+- If value(`updateContent`) is empty, trigger a same event `update_content` on element.
+
+Import CSS
+
+```css
+import "phoenix_duskmoon/priv/static/phoenix_duskmoon.css"
+```
+
+## Live Storybook
+
+[Live Storybook](https://duskmoon-storybook.gsmlg.dev)

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "phoenix_duskmoon",
+  "version": "4.0.0",
+  "main": "./priv/static/phoenix_duskmoon.js",
+  "exports": {
+    ".": "./priv/static/phoenix_duskmoon.js",
+    "./css": "./priv/static/phoenix_duskmoon.css",
+    "./svg/mdi/*.svg": "./priv/mdi/svg/*.svg",
+    "./svg/bsi/*.svg": "./priv/bsi/svg/*.svg"
+  },
+  "scripts": {
+    "build": "mix tailwind default && mix esbuild default"
+  },
+  "files": [
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "package.json",
+    "priv/static/",
+    "priv/svg/"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@gsmlg/lit": "^1.29.5",
+    "lit": "^2.4.1",
+    "lit-element": "^3.2.2",
+    "lit-html": "^2.4.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.5",
+    "@babel/preset-env": "^7.20.2"
+  },
+  "peerDependencies": {
+    "@gsmlg/lit": "^1.29.5",
+    "lit": "^2.4.1",
+    "lit-element": "^3.2.2",
+    "lit-html": "^2.4.0"
+  }
+}