@digitransit-component/digitransit-component-favourite-bar

formatFavourite

Utility to format location [name, address] pair.

Parameters

• favourite LocationProperties

Returns Array<string>

favourites

Required. Array of favourites, favourite object contains following properties.

Type: Array<object>

Properties

• address string
• gtfsId string
• gid string
• lat number
• lon number
• name string
• selectedIconId string
• favouriteId string

onClickFavourite

Required. Function for clicking favourites.

onAddPlace

Required. Function for selecting "Add place" from suggestions.

onEdit

Required. Function for selected "Edit" from suggestions.

onAddHome

Required. Function for "Add home" button.

onAddWork

Required. Function for "Add work" button.

lang

Optional. Language, fi, en or sv.

isLoading

Optional. Whether to show loading animation, true or false.

colors

Optional color palette

FavouriteBar

FavouriteBar renders favourites. FavouriteBar displays the first two favourites, the rest are shown in a list.

Parameters

• $0 Object

  • $0.favourites
  • $0.onClickFavourite
  • $0.onAddPlace
  • $0.onEdit
  • $0.onAddHome
  • $0.onAddWork
  • $0.lang (optional, default 'fi')
  • $0.isLoading (optional, default false)
  • $0.colors (optional, default defaultColors)

Examples

<FavouriteBar
  favourites={favourites}
  onClickFavourite={onClickFavourite}
  onAddPlace={onAddPlace}
  onEdit={onEdit}
  onAddHome={onAddHome}
  onAddWork={onAddWork}
  lang={lang}
  isLoading={isLoading}
/>

---

This module is part of the Digitransit-ui project. It is maintained in the HSLdevcom/digitransit-ui repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @digitransit-component/digitransit-component-favourite-bar