Flutter 重复造轮子 (10) Notice Bar 消息通知显示组件的封装

详细可以访问仓库 HcUi: 重复创造Flutter 的轮子 在原有组件上拓展 展现出新的特性 (gitee.com)

介绍

给用户提示文字消息


450fc559-2a6e-48d3-942a-9b98eef19acc.gif

代码演示

基础用法

       HcNoticeBar(
            content: "这是普通的通知公告",
          ),

带图标的公告

          HcNoticeBar(
            prefixIcon: Icon(Icons.info_outline),
            content: "带双侧图标的通知公告",
            suffixIcon: Icon(Icons.close),
          ),

带回调的公告

           HcNoticeBar(
            prefixIcon: Icon(Icons.info_outline),
            content: "带回调的通知公告",
            suffixIcon: Icon(Icons.close),
            callback: (String name) {
              print("我点击的部位是:${name}");
            },
          ),

横向滚动的公告

             HcNoticeBar(
            showType: HcNoticeBarShowType.scroll,
            //不满一行强制滚动
            forceScroll: true,
            prefixIcon: Icon(Icons.info_outline),
            content: "这是一个横向滚动的公告",
            suffixIcon: Icon(Icons.close),
            callback: (String name) {
              print("我点击的部位是:${name}");
            },
          ),

纵向滚动的公告

          HcNoticeBar(
            showType: HcNoticeBarShowType.scroll,
            scrollDirection: Axis.vertical,
            duration: 2000,
            prefixIcon: Icon(Icons.info_outline),
            content: "这是一个文字按长度自动分割的纵向滚动的公告啊啊啊",
            suffixIcon: Icon(Icons.close),
            callback: (String name) {
              print("我点击的部位是:${name}");
            },
          ),

自定义纵向滚动的公告

           HcNoticeBar(
            showType: HcNoticeBarShowType.scroll,
            scrollDirection: Axis.vertical,
            duration: 6000,
            prefixIcon: Icon(Icons.info_outline),
            contentGroup: [
              "风急天高猿啸哀,",
              "渚清沙白鸟飞回。",
              "无边落木萧萧下,",
              "不尽长江滚滚来。",
              "万里悲秋常作客,",
              "百年多病独登台。",
              "艰难苦恨繁霜鬓,",
              "潦倒新停浊酒杯。"
            ],
            suffixIcon: Icon(Icons.close),
            callback: (String name) {
              print("我点击的部位是:${name}");
            },
          ),

自定义内容组件

          HcNoticeBar(
            prefixIcon: Icon(Icons.info_outline),
            contentWidget: Text("这是一个自定义的组件 "),
            suffixIcon: Icon(Icons.close),
          ),

横向手动拖动显示

          HcNoticeBar(
            showType: HcNoticeBarShowType.drag,
            prefixIcon: Icon(Icons.info_outline),
            content: "横向文字过长时候,不会显示省略符可以手动拖动显示完全 ",
          ),

展示全部信息

       HcNoticeBar(
            showType: HcNoticeBarShowType.full,
            prefixIcon: Icon(Icons.info_outline),
            content:
                "生态文明建设是关系中华民族永续发展的根本大计。习近平总书记指出,要把建设美丽中国摆在强国建设、民族复兴的突出位置,以高品质生态环境支撑高质量发展,加快推进人与自然和谐共生的现代化。各地坚持以习近平生态文明思想为指引,牢固树立和践行绿水青山就是金山银山的理念,以更高站位、更宽视野、更大力度,全面推进美丽中国建设。",
            suffixIcon: Icon(Icons.close),
          ),

展示指定行数信息

          HcNoticeBar(
            showType: HcNoticeBarShowType.ellipsis,
            maxLines: 2,
            prefixIcon: Icon(Icons.info_outline),
            content:
            "生态文明建设是关系中华民族永续发展的根本大计。习近平总书记指出,要把建设美丽中国摆在强国建设、民族复兴的突出位置,以高品质生态环境支撑高质量发展,加快推进人与自然和谐共生的现代化。各地坚持以习近平生态文明思想为指引,牢固树立和践行绿水青山就是金山银山的理念,以更高站位、更宽视野、更大力度,全面推进美丽中国建设。",
            suffixIcon: Icon(Icons.close),
          ),

API

props

参数 说明 类型 默认值 是否必填
maxLines 需要展示的行数 int 1 false
scrollDirection 滚动方向 Axis Axis.horizontal false
prefixIcon 左侧图标 Widget - false
suffixIcon 右侧图标 Widget - false
spacing 组件内间隔 double 8.0 false
contentWidget 自定义内容组件 Widget - false
content 文字内容 String - true
contentGroup 文字内容组(纵向滚动) List<String> - false
showType 展示类型 HcNoticeBarShowType HcNoticeBarShowType.ellipsis true
forceScroll 横向滚动时不满一屏是否强制滚动 bool false false
duration 滚动时长(毫秒) duration 600000 false
textStyle 文字样式 TextStyle - false
decoration 背景装饰器 BoxDecoration - false
padding 组件内边距 EdgeInsets (v:16,h:8) false
maxLines 文字最大展示行数 int 1 false
callback 点击的回调 HcNoticeBarCallback - false

HcNoticeBarShowType

展示内容组件的方式(不对自定义内容组件控制)

参数名 说明
drag 手动滑动(横向/纵向)
scroll 自动滚动(横向/纵向)
ellipsis 带缩略符号(展示多少maxLines控制)
full 全部展示

Function

方法名 说明 参数 返回类型
HcNoticeBarCallback 点击相应部分的回调 Function(String name) void

项目源码

ypedef HcNoticeBarCallback = Function(String);

enum HcNoticeBarShowType {
  drag,
  scroll,
  ellipsis,
  full,
}

class HcNoticeBar extends StatelessWidget {
  //滚动方向
  final Axis scrollDirection;

  //左侧图标
  final Widget? prefixIcon;

  //尾部图标
  final Widget? suffixIcon;

  // 滚动的通知内容
  final String? content;

  //滚动通知的内容组 用于纵向滚动 如果横向滚动文字会拼接
  final List<String>? contentGroup;

  //不满一屏是否强制滚动
  final bool forceScroll;

  //中间的自定义组件
  final Widget? contentWidget;

  //间隔
  final double spacing;

  //组件的点击回调
  final HcNoticeBarCallback? callback;

  //展示的类型
  final HcNoticeBarShowType showType;

  //滚动时长
  final Duration duration;

  //文字样式
  final TextStyle textStyle;

  //北京装饰器
  final BoxDecoration decoration;

  //边距
  final EdgeInsets padding;

  //最大显示行数
  final int maxLines;

  const HcNoticeBar(
      {super.key,
      this.scrollDirection = Axis.horizontal,
      this.prefixIcon,
      this.suffixIcon,
      this.spacing = 8.0,
      this.callback,
      this.contentWidget,
      this.content,
      this.contentGroup,
      this.showType = HcNoticeBarShowType.ellipsis,
      this.forceScroll = false,
      this.duration = const Duration(milliseconds: 600000),
      this.textStyle = const TextStyle(color: Colors.black, fontSize: 16),
      this.decoration = const BoxDecoration(color: Colors.transparent),
      this.padding = const EdgeInsets.symmetric(vertical: 12, horizontal: 8),
      this.maxLines = 1});

  const HcNoticeBar.scroll(
      {super.key,
      required this.scrollDirection,
      this.prefixIcon,
      this.suffixIcon,
      this.content,
      this.contentGroup,
      this.forceScroll = false,
      this.contentWidget,
      this.spacing = 8.0,
      this.callback,
      this.duration = const Duration(milliseconds: 600000),
      this.textStyle = const TextStyle(color: Colors.black, fontSize: 16),
      this.decoration = const BoxDecoration(),
      this.padding = const EdgeInsets.symmetric(vertical: 16, horizontal: 8)})
      : showType = HcNoticeBarShowType.scroll,
        maxLines = 1;

  @override
  Widget build(BuildContext context) {
    Widget buildContent() {
      if (contentWidget != null) {
        return contentWidget!;
      }
      if (showType == HcNoticeBarShowType.scroll ||
          showType == HcNoticeBarShowType.drag) {
        return HcMarquee(
          duration: duration,
          textStyle: textStyle,
          forceScroll:forceScroll,
          enableScroll: showType == HcNoticeBarShowType.scroll,
          content: content,
          contentList: contentGroup,
          scrollDirection: scrollDirection,
        );
      }
      return HcTextEllipsis(
        separateShow: false,
        showEllipsisBtn: callback != null,
        content: content ?? contentGroup?.join("") ?? "",
        contentStyle: textStyle,
        expandText: "详情",
        maxLines: showType == HcNoticeBarShowType.full ? 2 * 31 : maxLines,
      );
    }

    Widget buildGestureDetector({name, child}) {
      return GestureDetector(
        child: child,
        onTap: () {
          if (callback != null) {
            callback!.call(name);
          }
        },
      );
    }

    return Container(
      padding: padding,
      decoration: decoration,
      child: Row(
        children: [
          if (prefixIcon != null)
            Padding(
              padding: EdgeInsets.only(right: spacing),
              child: buildGestureDetector(name: 'prefix', child: prefixIcon!),
            ),
          Expanded(
              child: buildGestureDetector(
            name: 'content',
            child: buildContent(),
          )),
          if (suffixIcon != null)
            Padding(
              padding: EdgeInsets.only(left: spacing),
              child: buildGestureDetector(name: 'suffix', child: suffixIcon!),
            ),
        ],
      ),
    );
  }
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容