Kancha Documentation
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ButtonProps

Index

Properties

Properties

Optional block

block: Kancha.BlockPropsOptions

The block appearance of the button

Optional bold

bold: undefined | false | true

The text to be displayed

Optional buttonText

buttonText: undefined | string

The text to be displayed

Optional centered

centered: undefined | false | true

Center the button horizontally on screen

Optional disabled

disabled: undefined | false | true

Disbable the button

Optional fullWidth

fullWidth: undefined | false | true

Remove width limitations

Optional icon

icon: React.ReactNode

Provide an icon component

Optional iconButton

iconButton: undefined | false | true

Icon button flag

Optional navButton

navButton: undefined | false | true

The button is a navigation button

Optional noPadding

noPadding: undefined | false | true

Remove button padding for icon buttons

onPress

onPress: function

The button type. This sets the theme color

Type declaration

    • (): void

    • Returns void

Optional shadowOpacity

shadowOpacity: undefined | number

Shadow

Optional small

small: undefined | false | true

Enable smaller button

Optional testID

testID: undefined | string

Provide a testID for e2e tests

Optional textDecorationLine

textDecorationLine: "none" | "underline" | "line-through" | "underline line-through" | undefined

Text decoration

theme

theme: any

Theme used by theme provider

Optional type

type: Kancha.BrandPropOptions

The button type. This sets the theme color

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc