导航栏 Navbar

为页面提供导航功能，用于页面顶部

使用

API

安装使用

import { TiNavbar } from '@titian-design/mobile-react'

用法示例

基础用法

const App: React.FC = () => {
  return (
    <>
      <TiNavbar title="标题" />
      <TiNavbar title="标题" subtitle="副标题" />
    </>
  )
}

沉浸式

const App: React.FC = () => {
  const ref = useRef();
  const onScroll = e => {
    ref.current.updateOpacity({ scrollTop: e.target.scrollTop });
  };
  return (
    <div onScroll={onScroll}>
      <TiNavbar ref={ref} title="标题" type="immersion" />
      滚动区域
    </div>
  )
}

毛玻璃效果

在没有占位的情况下有效，沉浸式模式默认没有占位

const App: React.FC = () => {
  return (
    <>
      <TiNavbar title="标题" usePlaceholder={false} frostedGlass />
      <TiNavbar title="标题" type="immersion" frostedGlass />
    </>
  )
}

返回和回到首页

const App: React.FC = () => {
  const back = () => {}
  const home = () => {}
  return (
    <>
      <TiNavbar title="标题" useHomeButton onBack="back" onHome="home" />
    </>
  )
}

自定义icon

const App: React.FC = () => {
  const back = () => {}
  const home = () => {}
  return (
    <>
      // 城市选择
      <TiNavbar title="标题">
        <div slot="prefix">城市<TiIcon name="arrow-down" /></div>
      </TiNavbar>

      // 自定义返回
      <TiNavbar title="标题">
        <div slot="prefix"><TiIcon name="arrow-back" />返回</div>
      </TiNavbar>

      // 自定义搜索
      <TiNavbar title="标题">
        <div slot="prefix"><TiIcon name="search" />搜索 </div>
      </TiNavbar>

      // 自定义title
      <TiNavbar>
        <div slot="title">
          <TiTabs tabs={ ['全部', '热销'] } extStyle="width: 160px;--tabs-background-color: transparent" />
        </div>
      </TiNavbar>

      // 右侧icon
      <TiNavbar title="标题" rightIcons={['category']} />
    </>
  )
}

TiNavbar API

属性 Properties

名称	类型	必填	默认值	说明	备注
type	string	否	normal	导航栏的风格，常规模式：normal 沉浸式：immersion	-
background	string	否	-	导航栏的背景，可设置颜色，渐变色，图片，同css属性background用法	-
fontColor	string	否	-	导航条前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000	-
title	string	否	-	导航栏的标题	-
subtitle	string	否	-	导航栏的副标题	-
leftIcons	array	否	-	导航栏左侧图标集合	-
rightIcons	array	否	-	导航栏右侧图标集合	H5专属
usePlaceholder	boolean	否	true	是否自动产生一个占位，可以避免导航栏遮盖下面的元素	-
useBackButton	boolean	否	true	使用组件内部返回按钮	-
useHomeButton	boolean	否	false	使用组件内部回到首页按钮	-
transitionDistance	number	否	100	沉浸式模式下，滑动指定距离，标题部分从透明至完全显示	-
transitionStartTop	number	否	50	沉浸式模式下，动画开始的起始距离	-
frostedGlass	boolean	否	false	毛玻璃效果，在usePlaceholder为false 或者 沉浸式模式下有效	-
subtitleHeight	number	否	-	使用了subtitle的插槽的情况下，副标题内容高度，此时subtitleHeight为必传	-
loading	boolean	否	false	是否使用loading	-
extStyle	string | Record<string, string>	否	-	根节点样式	-

事件 Events

名称	参数列表	描述	备注
onClickIcon	(e: CustomEvent<{iconName: string}>) => void	点击左侧或者右侧icon时触发	-
onBack	(e: CustomEvent<{iconName: string}>) => void	点击默认返回按钮时触发	-
onHome	(e: CustomEvent<{iconName: string}>) => void	点击默认回到首页按钮时触发	-

插槽 Slots

名称	说明	备注
prefix	导航栏左侧图标位置插槽	-
title	导航栏中间标题位置插槽	-
suffix	导航栏右侧位置插槽	H5专属

外部样式类 External Classes

名称	说明	备注
extTitleClass	标题样式类名	-
extSubtitleClass	副标题样式类名	-
extClass	根节点样式类名	-

CSS 变量 CSS Variable

变量	默认值	说明	备注
--navbar-title-font-size	34rpx	标题字号	-
--navbar-title-color	#000000	标题颜色，仅支持 #ffffff 和 #000000	-
--navbar-title-max-width	346rpx	标题最大宽度	-
--navbar-subtitle-font-size	24rpx	副标题字号	-
--navbar-subtitle-color	#9e9e9e	副标题颜色	-
--navbar-padding-h	16rpx	导航栏水平方向内边距	-
--navbar-background	#ffffff	导航栏背景	----
--navbar-backdrop-filter	blur(15px)	毛玻璃效果的虚化程度	-
--navbar-menu-background	-	左侧自定义的胶囊按钮的背景色	-
--navbar-menu-border-color	-	左侧自定义的胶囊按钮的边框颜色	-