1.0.0-alpha.30 • Published 3 years ago

@talixo/address v1.0.0-alpha.30

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

Talixo Address

UI component which represents address and path of waypoints

How to install

Package is available as @talixo/address in NPM registry, so you can use it in your project using npm install @talixo/address --save or yarn add @talixo/address.

Requirements

Your package should additionally have some extra dependencies:

  • @talixo/icon: ^1.0.0-alpha.30
  • @talixo/shared: ^1.0.0-alpha.30
  • prop-types: ^15.6.1
  • react: ^16.2.0
  • react-dom: ^16.2.0

These packages are required by @talixo/address, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

Address

Property nameTypeDefaultDescription
addressstringn/aAddress of a place.
classNamestringn/aAdditional class name passed to wrapper.
detailsstringn/aPlace details.
formatDetailsfunctionx => xFormat details.
typestringn/aAddress type to determine icon displayed next to the address.
shortstringn/aPlace name abbreviation. It can be e.g. IATA code of an airport.

AddressPath

Property nameTypeRequiredDefaultDescription
childrennodestruen/aE.x. steps of a journey. Works best with Address component.
classNamestringfalsen/aAutoComplete list footer.

AddressIconsProvider

Property nameTypeRequiredDefaultDescription
childrennodestruen/aElements to render which will get this new map of icons through context.
typesobjectfalsemap with most popular Google Maps type coveredMap address type => icon name

Changelog

  • 0.1.0 - initial version
1.0.0-alpha.36

3 years ago

1.0.0-alpha.35

3 years ago

1.0.0-alpha.31

3 years ago

1.0.0-alpha.30

3 years ago