#alert #yew #yew-component #rust

无 std yew-alert

⚠️ Yew 框架的简单灵活警报组件

1 个不稳定版本

0.1.0 2024年2月3日

#2088 in 网页编程

34 每月下载量
next-rs 中使用

MIT 许可证

27KB
265

⚠️ Yew Alert

Crates.io Crates.io Downloads Crates.io License Rust


Demo


📜 简介

Yew Alert 是 Yew 框架的一个简单而灵活的警报组件,旨在提供可定制的响应式警报,以增强用户交互。

🤔 为什么这个组件有用?

警报组件为您的网络应用程序提供了一些好处

  1. ⚙️ 可定制性:根据您的应用程序的设计和需求定制警报的外观和行为。

  2. 🚀 响应式设计:确保在各种设备和屏幕尺寸上显示和交互的最佳效果。

  3. 💬 简单集成:轻松将警报集成到 Yew 项目中,无需复杂的设置和配置。

⚙️ 安装

将 Yew Alert 集成到您的 Yew 项目中非常简单。请按照以下步骤操作

  1. 确保您已经在项目中设置了 Yew。如果没有,请参阅 Yew 文档 了解安装说明。

  2. 使用您首选的包管理器安装库

    $ cargo add yew-alert
    
  3. 开始使用警报组件来增强您应用程序的用户反馈。

🛠️ 使用方法

将 Yew Alert 集成到您的应用程序中非常简单。请按照以下步骤操作

  1. 将警报组件导入到您的 Yew 项目中

    use yew::prelude::*;
    use yew_alert::Alert;
    
  2. 定义警报属性并在您的 Yew 组件中使用警报组件

    #[function_component(App)]
    pub fn app() -> Html {
        let show_alert = use_state(|| true);
        html! {
            <Alert
                message={"This is an alert message"}
                show_alert={show_alert}
                timeout={2500}
                title={"Alert Title"}
                alert_class={"w-96 h-48 text-white"}
                icon_class={"flex justify-center"}
                confirm_button_text={"Okay"}
                cancel_button_text={"Cancel"}
                confirm_button_class={"bg-green-500 text-white rounded"}
                cancel_button_class={"bg-red-500 text-white rounded"}
                show_confirm_button={true}
                show_cancel_button={true}
                show_close_button={true}
                on_confirm={Callback::noop()}
                on_cancel={Callback::noop()}
                position={"top-right"}
                container_class={"flex items-center text-center justify-center bg-gray-800 text-white border border-gray-600"}
                title_class={"dark:text-white"}
                message_class={"dark:text-gray-300"}
                icon_type={"success"}
                icon_color={""}
                icon_width={"50"}
            />
        }
    }
    
  3. 使用提供的 props 定制警报的外观和行为。

  4. 使用 Yew Alert 增强用户反馈。

🔧 Props

主要 Props

名称 类型 默认值 描述
message &'static str "" 警报的消息内容。
show_alert UseStateHandle<bool> UseStateHandle::new(false) 控制警报可见性的状态。
timeout u32 2500 警报自动关闭前的持续时间(毫秒)。
title &'static str "Info" 警报的标题。

样式和布局 Props

名称 类型 默认值 描述
alert_class &'static str "w-96 h-48 text-white" 应用于警报容器的类。
icon_class &'static str "flex justify-center" 应用于图标容器的类。

按钮 Props

名称 类型 默认值 描述
confirm_button_text &'static str "确定" 确认按钮上显示的文本。
cancel_button_text &'static str "取消" 取消按钮上显示的文本。
confirm_button_class &'static str "bg-green-500 text-white rounded" 应用于确认按钮的类。
cancel_button_class &'static str "bg-red-500 文本白色 圆角" 应用于取消按钮的类。
show_confirm_button bool true 确定是否显示确认按钮。
show_cancel_button bool true 确定是否显示取消按钮。
show_close_button bool true 确定是否显示关闭按钮(x)。

定位和布局属性

名称 类型 默认值 描述
position &'static str "右上角" 警告在屏幕上的位置。可能的值:"左上角"、"右上角"、"中间"、"底部"、"顶部"、"右下角"、"左下角"。
container_class &'static str "flex items-center text-center justify-center bg-gray-800 text-white border border-gray-600" 应用于警告最外层容器的类。
title_class &'static str "dark:text-white" 应用于警告标题的类。
message_class &'static str "dark:text-gray-300" 应用于警告消息的类。

图标属性

名称 类型 默认值 描述
icon_type &'static str "success" 要显示的图标类型。可能的值:"警告"、"错误"、"成功"、"信息"、"问题"。
icon_color &'static str "" 图标的颜色。如果为空,则根据图标类型使用默认颜色。
icon_width &'static str "50" 图标的宽度。

📙 示例

示例文件夹中探索不同的样式和功能。

🤝 贡献

我们欢迎社区贡献以增强此组件。请随意打开问题、提交拉取请求或提供反馈。让我们共同努力,使Yew的用户交互更加动态和用户友好!

📜 许可证

Yew Alert在MIT许可证下发布,允许您自由使用、修改和分发。有关详细信息,请参阅LICENSE文件。

依赖项

~10–14MB
~254K SLoC