wok-ui-feedback

Provide unified loading, toast, and dialog feedback APIs for wok-ui apps.

Updated Sep 14, 2023
One-click install
npx skills add https://github.com/PeakTai/wok-ui --skill wok-ui-feedback
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wok-ui-feedback
Source: https://github.com/PeakTai/wok-ui/tree/main/skills/wok-ui-feedback
Command: npx skills add https://github.com/PeakTai/wok-ui --skill wok-ui-feedback

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

wok-ui 内置了一套用户反馈系统,包括全屏 Loading、弹出式 Toast、以及需要用户交互的 Alert/Confirm 对话框,帮助应用提供一致且高质量的用户体验。

Core Features & Use Cases

  • 全屏 Loading:通过 showLoading / hideLoading 显示和隐藏全屏加载指示,确保阻塞操作的视觉反馈。
  • Toast 与通知:使用 showToast / showSuccess / showWarning 提供可自定义文本和时长的提示。
  • 对话框:提供 showAlert / showConfirm,简化需要用户确认的场景,支持国际化标题和按钮文本。

Quick Start

Call the feedback APIs to show a loading overlay, display a toast, and present an alert/confirm dialog.

Frequently Asked Questions about wok-ui-feedback

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I show a full-screen loading indicator for blocking operations in a wok-ui dashboard?

To show a full-screen loading indicator for blocking operations in a wok-ui dashboard, call the showLoading API. You can then remove the visual feedback by calling hideLoading once the operation completes.

What is the best way to display toast notifications and alerts in a wok-ui app?

The best way to display toast notifications and alerts in a wok-ui app is using the unified feedback system. It exposes showToast, showSuccess, and showWarning for customizable alerts, plus showAlert and showConfirm for interactive dialogs.

Does the wok-ui feedback system support internationalized dialog titles and button text?

Yes, the wok-ui feedback system supports internationalized dialog titles and button text. The showAlert and showConfirm dialogs offer optional i18n support to maintain consistent user experiences across different languages.

Are the wok-ui feedback APIs type-safe when integrating with TypeScript?

Yes, the wok-ui feedback APIs are fully type-safe when integrating with TypeScript. The system provides type-safe APIs for managing loading indicators, toast alerts, and modal dialogs across various application workflows.

When do I need a unified user feedback system for TypeScript apps?

You need a unified user feedback system for TypeScript apps when standardizing progress indicators, toasts, and modal dialogs across different workflows. It ensures consistent user experiences for full-screen loading, alerts, and confirmations.

Can I customize the duration and text of toast alerts using wok-ui?

Yes, you can customize the duration and text of toast alerts using wok-ui. The showToast, showSuccess, and showWarning APIs accept parameters to define custom text and display duration for user notifications.