@overlastic/svelte 0.4.3 → 0.5.1

package/LICENSE

@@ -1,23 +1,23 @@
-MIT License
-
-Copyright (c) 2022-PRESENT Hairyf<https://github.com/hairyf>
-
-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.
-
-
+MIT License
+
+Copyright (c) 2022-PRESENT Hairyf<https://github.com/hairyf>
+
+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

@@ -1,102 +1,29 @@
-# Getting Started
-
-create imperative overlays in the svelte application, supporting context inheritance!
-
-## Install
-
-With pnpm: 
-```sh
-pnpm add @overlastic/svelte
-```
-
-With yarn:
-```sh
-yarn add @overlastic/svelte
-```
-
-## Usage
-
-
-### Step 1: Define Component
-
-
-```svelte
-<script lang="ts">
-  import { usePrograms, Overlay } from "@overlastic/svelte";
-  import { fly } from "svelte/transition";
-  
-  export let title: number
-  export let duration = 200
-
-  // duration of overlay duration, helps prevent premature component destroy
-  const { resolve, reject } = usePrograms({ duration })
-
-  function onClick() {
-    resolve(`${title}:confirmed`)
-  }
-</script>
-
-<Overlay>
-  <div transition:fly={{ opacity: 0, duration }} on:click={onClick}>
-    <slot name="title">
-      { title }
-    </slot>
-  </div>
-</Overlay>
-```
-
-### Step 2: Create Overlay
-
-You can use the `defineOverlay` method to convert the component into a modal dialog in Javascript / Typescript, which allows you to call it.
-
-```ts
-import { defineOverlay } from '@overlastic/svelte'
-import OverlayComponent from './overlay.svelte'
-
-// Convert to imperative callback
-const callback = defineOverlay(OverlayComponent)
-// Call the component and get the value of the resolve callback
-const value = await callback({ title: 'callbackOverlay' })
-// value === "callbackOverlay:confirmed"
-```
-
-You can also use `renderOverlay` to directly call the component and skip the `defineOverlay` method.
-
-```ts
-import { renderOverlay } from '@overlastic/svelte'
-import OverlayComponent from './overlay.svelte'
-
-const value = await renderOverlay(OverlayComponent, {
-  title: 'usePrograms'
-})
-// value === "usePrograms:confirmed"
-```
-
-## Controlled manner
-
-By default, you do not need to control the display and hiding of the `visible` variable. The value is controlled by the component `Overlay`, and you can pass in `visible` to control the display
-
-
-```svelte
-<script lang="ts">
-  import { usePrograms, Overlay } from "@overlastic/svelte";
-
-  let visible = false
-
-  const { resolve, reject, deferred, vanish } = usePrograms({
-    // close the transition duration, at this point you need to manually destroy it
-    duration: false,
-    // cancel setting visible to true immediately
-    immediate: false
-  })
-
-  // Manually set vanish (when promise ends)
-  deferred.finally(() => vanish())
-</script>
-
-<Overlay bind:visible={visible}>
-  <div on:click={() => resolve(`${title}:confirmed`)}>
-    ...
-  </div>
-</Overlay>
-```
+<p align="center">
+  <a href="https://overlastic.vercel.app/" target="blank">
+    <img src="https://github.com/hairyf/overlastic/raw/master/docs/public/circle.svg" width="120" alt="Nest Logo" />
+  </a>
+</p>
+
+<p align="center">
+ A create modal | dialog | popup promise deferred library
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/@overlastic/svelte"><img src="https://img.shields.io/npm/v/@overlastic/svelte.svg" alt="NPM Version" /></a>
+  <a href="https://www.npmjs.com/@overlastic/svelte"><img src="https://img.shields.io/npm/l/@overlastic/svelte.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/@overlastic/svelte"><img src="https://img.shields.io/npm/dm/@overlastic/svelte.svg" alt="NPM Downloads" /></a>
+</p>
+
+## Description
+
+Create messages or dialog overlays using Overlastic in Svelte APP.
+
+## Installation
+
+```bash
+$ npm install --save @overlastic/svelte
+```
+
+## Quick Start
+
+[Overview & Tutorial](https://overlastic.vercel.app/en/svelte/)

package/dist/index.cjs

@@ -23,7 +23,7 @@ __export(src_exports, {
   Overlay: () => Overlay,
   defineOverlay: () => defineOverlay,
   renderOverlay: () => renderOverlay,
-  usePrograms: () => usePrograms
+  useOverlayDefine: () => useOverlayDefine
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -38,7 +38,7 @@ var injectOptionsKey = Symbol("overlays:options");
 var constructor = (0, import_core.createConstructor)((Inst, props, options) => {
   const { container, deferred, context: _context = /* @__PURE__ */ new Map() } = options;
   function vanish() {
-    childApp.$destroy();
+    app.$destroy();
     container.remove();
   }
   const context = new Map([..._context.entries()]);
@@ -49,7 +49,7 @@ var constructor = (0, import_core.createConstructor)((Inst, props, options) => {
     visible: false,
     vanish
   });
-  const childApp = new Inst({
+  const app = new Inst({
     target: container,
     props,
     context
@@ -60,9 +60,9 @@ var constructor = (0, import_core.createConstructor)((Inst, props, options) => {
 var defineOverlay = constructor.define;
 var renderOverlay = constructor.render;
 
-// src/composable/usePrograms.ts
+// src/composable/define.ts
 var import_svelte = require("svelte");
-function usePrograms(options = {}) {
+function useOverlayDefine(options = {}) {
   (0, import_svelte.setContext)(injectOptionsKey, options);
   return (0, import_svelte.getContext)(injectOverlayKey);
 }
@@ -226,5 +226,5 @@ var Overlay = class extends import_internal3.SvelteComponentTyped {
   Overlay,
   defineOverlay,
   renderOverlay,
-  usePrograms
+  useOverlayDefine
 });

package/dist/index.d.cts

@@ -23,13 +23,13 @@ interface ProgramsReturn {
     deferred?: Deferred<any>;
 }
 
-interface ProgramsOptions {
+interface OverlayDefineOptions {
     /** animation duration to avoid premature destruction of components */
     duration?: number;
     /** whether to set visible to true immediately */
     immediate?: boolean;
 }
-declare function usePrograms(options?: ProgramsOptions): ProgramsReturn;
+declare function useOverlayDefine(options?: OverlayDefineOptions): ProgramsReturn;
 
 declare class Overlay extends SvelteComponentTyped<{
     visible?: boolean;
@@ -37,4 +37,4 @@ declare class Overlay extends SvelteComponentTyped<{
     constructor(options: ComponentConstructorOptions);
 }
 
-export { Overlay, type ProgramsOptions, type ProgramsReturn, defineOverlay, renderOverlay, usePrograms };
+export { Overlay, type OverlayDefineOptions, type ProgramsReturn, defineOverlay, renderOverlay, useOverlayDefine };

package/dist/index.d.ts

@@ -23,13 +23,13 @@ interface ProgramsReturn {
     deferred?: Deferred<any>;
 }
 
-interface ProgramsOptions {
+interface OverlayDefineOptions {
     /** animation duration to avoid premature destruction of components */
     duration?: number;
     /** whether to set visible to true immediately */
     immediate?: boolean;
 }
-declare function usePrograms(options?: ProgramsOptions): ProgramsReturn;
+declare function useOverlayDefine(options?: OverlayDefineOptions): ProgramsReturn;
 
 declare class Overlay extends SvelteComponentTyped<{
     visible?: boolean;
@@ -37,4 +37,4 @@ declare class Overlay extends SvelteComponentTyped<{
     constructor(options: ComponentConstructorOptions);
 }
 
-export { Overlay, type ProgramsOptions, type ProgramsReturn, defineOverlay, renderOverlay, usePrograms };
+export { Overlay, type OverlayDefineOptions, type ProgramsReturn, defineOverlay, renderOverlay, useOverlayDefine };

package/dist/index.global.js

@@ -24,7 +24,7 @@ var OverlaysSvelte = (() => {
     Overlay: () => Overlay,
     defineOverlay: () => defineOverlay,
     renderOverlay: () => renderOverlay,
-    usePrograms: () => usePrograms
+    useOverlayDefine: () => useOverlayDefine
   });
 
   // ../@core/src/define/global.ts
@@ -91,14 +91,15 @@ var OverlaysSvelte = (() => {
   }
 
   // ../@core/src/constructor.ts
-  function createConstructor(mount) {
-    function define(instance2, options) {
-      function executor(props, options2) {
+  function createConstructor(mount, options = {}) {
+    const { container: globalContainer } = options;
+    function define(instance2, options2) {
+      function executor(props, options3) {
         const deferred = createDeferred();
-        const name = defineName(options2.id, options2.autoIncrement);
-        const index = getIndex(options2.id);
-        const container = defineGlobalElement(name, options2.root);
-        mount(instance2, props, Object.assign(options2, {
+        const name = defineName(options3.id, options3.autoIncrement);
+        const index = getIndex(options3.id);
+        const container = globalContainer ? defineGlobalElement(name, options3.root) : document.body;
+        mount(instance2, props, Object.assign(options3, {
           position: context.position,
           id: name,
           deferred,
@@ -108,21 +109,21 @@ var OverlaysSvelte = (() => {
         return deferred;
       }
       let inst;
-      function only(props, options2) {
+      function only(props, options3) {
         if (!inst) {
-          inst = executor(props, options2);
+          inst = executor(props, options3);
           inst.finally(() => inst = void 0);
         }
         return inst;
       }
       function caller(props, overrides) {
-        const opts = { ...options, ...overrides };
+        const opts = { ...options2, ...overrides };
         return opts.only ? only(props, opts) : executor(props, opts);
       }
       return caller;
     }
-    function render(instance2, props, options) {
-      return define(instance2, options)(props);
+    function render(instance2, props, options2) {
+      return define(instance2, options2)(props);
     }
     return { define, render };
   }
@@ -141,7 +142,7 @@ var OverlaysSvelte = (() => {
   var constructor = createConstructor((Inst, props, options) => {
     const { container, deferred, context: _context = /* @__PURE__ */ new Map() } = options;
     function vanish() {
-      childApp.$destroy();
+      app.$destroy();
       container.remove();
     }
     const context2 = new Map([..._context.entries()]);
@@ -152,7 +153,7 @@ var OverlaysSvelte = (() => {
       visible: false,
       vanish
     });
-    const childApp = new Inst({
+    const app = new Inst({
       target: container,
       props,
       context: context2
@@ -605,8 +606,8 @@ var OverlaysSvelte = (() => {
   function onMount() {
   }
 
-  // src/composable/usePrograms.ts
-  function usePrograms(options = {}) {
+  // src/composable/define.ts
+  function useOverlayDefine(options = {}) {
     setContext(injectOptionsKey, options);
     return getContext(injectOverlayKey);
   }

package/dist/index.js

@@ -9,7 +9,7 @@ var injectOptionsKey = Symbol("overlays:options");
 var constructor = createConstructor((Inst, props, options) => {
   const { container, deferred, context: _context = /* @__PURE__ */ new Map() } = options;
   function vanish() {
-    childApp.$destroy();
+    app.$destroy();
     container.remove();
   }
   const context = new Map([..._context.entries()]);
@@ -20,7 +20,7 @@ var constructor = createConstructor((Inst, props, options) => {
     visible: false,
     vanish
   });
-  const childApp = new Inst({
+  const app = new Inst({
     target: container,
     props,
     context
@@ -31,9 +31,9 @@ var constructor = createConstructor((Inst, props, options) => {
 var defineOverlay = constructor.define;
 var renderOverlay = constructor.render;
 
-// src/composable/usePrograms.ts
+// src/composable/define.ts
 import { getContext, setContext } from "svelte";
-function usePrograms(options = {}) {
+function useOverlayDefine(options = {}) {
   setContext(injectOptionsKey, options);
   return getContext(injectOverlayKey);
 }
@@ -212,5 +212,5 @@ export {
   Overlay,
   defineOverlay,
   renderOverlay,
-  usePrograms
+  useOverlayDefine
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@overlastic/svelte",
   "type": "module",
-  "version": "0.4.3",
+  "version": "0.5.1",
   "license": "MIT",
   "homepage": "https://github.com/hairyf/overlastic#readme",
   "repository": {
@@ -26,7 +26,7 @@
   ],
   "dependencies": {
     "svelte": "^3.57.0",
-    "@overlastic/core": "^0.4.3"
+    "@overlastic/core": "^0.5.1"
   },
   "scripts": {
     "build": "tsup src/index.ts",