@digitransit-component/digitransit-component-control-panel

1.1.8 • Public • Published

@digitransit-component/digitransit-component-control-panel

NearStopsAndRoutes

Show button links to near you page for different travel modes

Parameters

  • props Object
    • props.modes Array<string> Names of transport modes to show buttons for. Should be in lower case. Also defines button order
    • props.urlPrefix string URL prefix for links. Must end with /lahellasi
    • props.language string Language used for accessible labels
    • props.showTitle boolean Show title, default is false
    • props.alertsContext Object
      • props.alertsContext.getModesWithAlerts function Function which should return an array of transport modes that have active alerts (e.g. [BUS, SUBWAY])
      • props.alertsContext.currentTime Number Time stamp with which the returned alerts are validated with
      • props.alertsContext.feedIds Number feedIds for which the alerts are fetched for
    • props.LinkComponent element React component for creating a link, default is undefined and normal anchor tags are used
    • props.origin
    • props.omitLanguageUrl

Examples

const alertsContext = {
   getModesWithAlerts: () => ({}),
   currentTime: 123456789,
   feedIds: [HSL]
}
<CtrlPanel.NearStopsAndRoutes
     modes={['bus', 'tram', 'subway', 'rail', 'ferry', 'citybike']}
     language="fi"
     urlPrefix="http://example.com/lahellasi"
     showTitle
     alertsContext={alertsContext}
   />

CtrlPanel

Extends React.Component

CtrlPanel gathers multiple components to same area (desktop-size: left or mobile-size: bottom)

Examples

<CtrlPanel language="fi" position="left">
   <CtrlPanel.OriginToDestination showTitle />
   <CtrlPanel.SeparatorLine />
   <CtrlPanel.NearStopsAndRoutes
     modes={['bus', 'tram', 'subway', 'rail', 'ferry', 'citybike']}
     language="fi"
     urlPrefix="http://example.com/lahellasi"
     showTitle
   />
 </CtrlPanel>

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-control-panel

Or install the digitransit-component module that includes it as a class:

$ npm install @digitransit-component/digitransit-component

Package Sidebar

Install

npm i @digitransit-component/digitransit-component-control-panel

Weekly Downloads

93

Version

1.1.8

License

(AGPL-3.0 OR EUPL-1.2)

Unpacked Size

147 kB

Total Files

6

Last publish

Collaborators

  • digitransit