Skip to content

快速开始(Quick Start)

本页帮助你在几分钟内完成安装、引入与首个可运行示例。

第 1 步:安装

bash
npm install sodialog

第 2 步:引入样式与 API

ts
import { openModal, openOffcanvas, toast } from 'sodialog'
import 'sodialog/style.css'

第 3 步:打开第一个组件

ts
openModal({
  title: 'Delete Item',
  content: '<p>Are you sure?</p>',
  confirmText: 'Confirm',
  cancelText: 'Cancel',
})

openOffcanvas({
  title: 'Filter',
  placement: 'end',
  content: '<p>Filter panel content.</p>',
})

toast({
  title: 'Saved',
  content: 'Configuration updated',
  variant: 'success',
})

第 3.5 步:30 秒实时演示

Quick Start: Modal Live Demo

Open in New Tab
Source Code

如果你想看队列策略,可直接打开 Toast 进阶演示:

CDN 说明(源码复制友好)

文档中的组件示例默认使用:

这样你复制示例源码后可以直接运行,不依赖本地 vendor 文件。

同时示例里保留了 jsdelivr 作为注释备用地址;如果你的网络对 unpkg 不稳定,可以把注释切换为启用:

js
const candidates = [
  'https://unpkg.com/[email protected]/dist/sodialog.es.js',
  // 'https://cdn.jsdelivr.net/npm/[email protected]/dist/sodialog.es.js', // backup
]

切换方式:将 jsdelivr 这一行取消注释,或把它移动到第一行作为首选源。

第 4 步:切换到 Adapter First 用法

通过 adapter defaults 统一默认行为,避免在业务代码里重复传参。

ts
import { configureAdapter, openDialog, pushMessage } from 'sodialog'

configureAdapter({
  modalDefaults: { closeOnEsc: true, footerAlign: 'center' },
  toastDefaults: { placement: 'top-end', maxVisible: 4 },
  diagnosticsEnabled: true,
})

openDialog({
  title: 'Delete Record',
  content: '<p>Do you want to continue?</p>',
  traceId: 'trace-order-001',
})

pushMessage('success', 'Operation completed', { traceId: 'trace-order-001' })

第 5 步:继续阅读文档

  1. Modal 指南
  2. Offcanvas 指南
  3. Toast 指南
  4. Context Menu 指南
  5. API 总览

Released under the MIT License.