https://github.com/yeungkc/svelte-portal

A Portal library for Svelte. Supports SSR and Portal updates.
https://github.com/yeungkc/svelte-portal

portal ssr svelte sveltejs sveltekit

Last synced: 3 months ago
JSON representation

A Portal library for Svelte. Supports SSR and Portal updates.

• Host: GitHub
• URL: https://github.com/yeungkc/svelte-portal
• Owner: YeungKC
• License: mit
• Created: 2022-09-17T10:47:40.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-05-23T23:04:36.000Z (8 months ago)
• Last Synced: 2024-05-28T23:34:44.991Z (8 months ago)
• Topics: portal, ssr, svelte, sveltejs, sveltekit
• Language: Svelte
• Homepage: https://svelte-portal.vercel.app/
• Size: 211 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README-zh.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# svelte-portal

一个用于 Svelte 的 Portal 库。**没有 Dom 移动操作**和支持 SSR。

在线 example：

example 代码：

## 安装

```bash

yarn add @yeungkc/svelte-portal -D

npm install @yeungkc/svelte-portal --save-dev

```

## 用法

### 设置 Portal 容器

一般在 +layout.svelte 设置 ``，例如：

```svelte

// +layout.svelte

```

可以设置多个 Portal Container，使用 name 参数区分：

```svelte

// +layout.svelte

```

### 展示 Portal

在想要展示 Portal 的地方设置 ``，用法和 `` 相同。

```svelte

```

如果 SomeComponent 需要参数 foo，可以在 `` 中添加：

```svelte

```

`portal-id` 为可选参数，为 portal 设置固定 id，默认为随机 id。

`portal-container-name` 为可选参数，为 portal 选择不同的 portal container。

## 已知问题

目前 svelte-portal 不能像  那样设置 bind 和转发 event。