lingxiaoyi / Taro-navigation-bar

微信小程序自定义导航栏组件,navigation,完美适配全部手机
461 stars 72 forks source link

建议添加Typescript类型声明文件 #6

Closed wkl007 closed 2 years ago

wkl007 commented 5 years ago

希望添加index.d.ts类型声明文件

RussellCao824 commented 4 years ago

是的,我自己在根目录创建了个index.d.ts,还得额外声明一下。

xiyionxiong commented 3 years ago
import {CommonEventFunction, StandardProps} from '@tarojs/components/types/common'
import {ComponentClass} from 'react'

export interface NavBarProps extends StandardProps {
  /**
   * 导航标题,如果不提供,则名为 renderCenter 的 slot 有效
   */
  title?: string

  /**
   * 导航字体颜色
   * @default #000000
   */
  color?: string
  /**
   *  是否显示返回按钮
   * @default false
   */
  back?: boolean

  /**
   * 在 back 为 true 时,生效
   * detail 包含 delta
   */
  delta?: number

  /**
   *  在 back 为 true 时,点击 back 按钮触发此事件,
   */
  onBack?: CommonEventFunction
  /**
    *  是否显示主页按钮
    * @default false
    */
  home?: boolean

  /**
    *  在 home 为 true 时,点击 home 按钮触发此事件
    */
  onHome?: CommonEventFunction
  /**
   * 是否显示搜索框
   *  @default false
   */
  searchBar?: boolean;
  /**
   * 搜索框文字
   *  @default 点我搜索
   */
  searchText?: string;

  /**
 * 点击搜索框
 */
  onSearch?: () => void;

  /**
   * 导航栏背景
   * @default #ffffff
   */
  background?: string

  /**
   * 导航下拉背景色,默认取 background 的颜色,不理解见 issue 问题
   * @default background
   */
  backgroundColorTop?: string
  /**
   * 添加在组件内部结构的 class,可用于修改组件内部的样式
   */
  extClass?: string
  /**
   * 主题图标和字体颜色,当背景色为深色时,可以设置'white'
   * @default black
   */
  iconTheme?: 'black' | 'white'
  /**
   * 左侧 slot,在 back 按钮位置显示,当 back 为 false 的时候有效
   */
  renderLeft?: any,
  /**
   * 标题 slot,在标题位置显示,当 searchBar 为 false title 为空的时候有效
   */
  renderCenter?: any,
  /**
   * 在导航的右侧显示
   */
  renderRight?: any,

}

declare const NavBar: ComponentClass<NavBarProps>

export default NavBar

index.d.ts

那个render 几个地方不知道用什么类型