Merge pull request #183 from opentripplanner/form-fixes

Add SettingsPreview and TripDetails messages

Author: landonreed

lib/components/form/form.css

@@ -126,6 +126,14 @@
   font-size: 14px;
   line-height: 1.4;
   margin-top: -1px;
+  white-space: pre-wrap;
+}
+
+.otp .settings-preview .summary.tall {
+  line-height: 2.6;
+}
+
+.otp:not(.mobile) .settings-preview .summary {
   /* Prevent overflow from being multi-line. 36px is edit button width. */
   width: calc(100% - 36px);
 }

lib/components/form/settings-preview.js

@@ -3,6 +3,7 @@ import PropTypes from 'prop-types'
 import { Button } from 'react-bootstrap'
 import { connect } from 'react-redux'
 
+import { mergeMessages } from '../../util/messages'
 import { isNotDefaultQuery } from '../../util/query'
 
 class SettingsPreview extends Component {
@@ -22,11 +23,15 @@ class SettingsPreview extends Component {
   }
 
   static defaultProps = {
-    editButtonText: <i className='fa fa-pencil' />
+    editButtonText: <i className='fa fa-pencil' />,
+    messages: {
+      label: 'Transit Options\n& Preferences'
+    }
   }
 
   render () {
-    const { config, query, caret, editButtonText } = this.props
+    const { caret, config, query, editButtonText } = this.props
+    const messages = mergeMessages(SettingsPreview.defaultProps, this.props)
     // Show dot indicator if the current query differs from the default query.
     let showDot = isNotDefaultQuery(query, config)
     const button = (
@@ -37,10 +42,14 @@ class SettingsPreview extends Component {
         {showDot && <div className='dot' />}
       </div>
     )
-
+    // Add tall class to account for vertical centering if there is only
+    // one line in the label (default is 2).
+    const addClass = messages.label.match(/\n/) ? '' : ' tall'
     return (
       <div className='settings-preview' onClick={this.props.onClick}>
-        <div className='summary'>Transit Options<br />&amp; Preferences</div>
+        <div className={`summary${addClass}`}>
+          {messages.label}
+        </div>
         {button}
         <div style={{ clear: 'both' }} />
       </div>
@@ -51,6 +60,7 @@ class SettingsPreview extends Component {
 const mapStateToProps = (state, ownProps) => {
   return {
     config: state.otp.config,
+    messages: state.otp.config.language.settingsPreview,
     query: state.otp.currentQuery
   }
 }

lib/components/narrative/trip-details.js

@@ -5,11 +5,31 @@ import { VelocityTransitionGroup } from 'velocity-react'
 import moment from 'moment'
 
 import { calculateFares, calculatePhysicalActivity, getTimeZoneOffset } from '../../util/itinerary'
+import { mergeMessages } from '../../util/messages'
 import { formatTime, getTimeFormat, getLongDateFormat } from '../../util/time'
 
 class TripDetails extends Component {
+  static defaultProps = {
+    // Note: messages with default null values included here for visibility.
+    // Overriding with a truthy string value will cause the expandable help
+    // message to appear in trip details.
+    messages: {
+      at: 'at',
+      caloriesBurned: 'Calories Burned',
+      // FIXME: Add templated string description.
+      caloriesBurnedDescription: null,
+      depart: 'Depart',
+      departDescription: null,
+      title: 'Trip Details',
+      fare: 'Fare',
+      transitFare: 'Transit Fare',
+      transitFareDescription: null
+    }
+  }
+
   render () {
     const { itinerary, timeFormat, longDateFormat } = this.props
+    const messages = mergeMessages(TripDetails.defaultProps, this.props)
     const date = moment(itinerary.startTime)
 
     // process the transit fare
@@ -25,15 +45,16 @@ class TripDetails extends Component {
       fare = (
         <span>
           {transitFare && (
-            <span>Transit Fare: <b>{centsToString(transitFare)}</b></span>
+            <span>{messages.transitFare}: <b>{centsToString(transitFare)}</b></span>
           )}
           {minTNCFare !== 0 && (
             <span>
               <br />
               <span style={{ textTransform: 'capitalize' }}>
                 {companies.toLowerCase()}
               </span>{' '}
-              Fare: <b>{dollarsToString(minTNCFare)} - {dollarsToString(maxTNCFare)}</b>
+              {messages.fare}:{' '}
+              <b>{dollarsToString(minTNCFare)} - {dollarsToString(maxTNCFare)}</b>
             </span>
           )}
         </span>
@@ -50,27 +71,36 @@ class TripDetails extends Component {
 
     return (
       <div className='trip-details'>
-        <div className='trip-details-header'>Trip Details</div>
+        <div className='trip-details-header'>{messages.title}</div>
         <div className='trip-details-body'>
           <TripDetail
+            description={messages.departDescription}
             icon={<i className='fa fa-calendar' />}
             summary={
               <span>
-                <span>Depart <b>{date.format(longDateFormat)}</b></span>
-                {this.props.routingType === 'ITINERARY' && <span> at <b>{formatTime(itinerary.startTime, timeOptions)}</b></span>}
+                <span>{messages.depart} <b>{date.format(longDateFormat)}</b></span>
+                {this.props.routingType === 'ITINERARY' &&
+                  <span>
+                    {' '}{messages.at}{' '}
+                    <b>{formatTime(itinerary.startTime, timeOptions)}</b>
+                  </span>
+                }
               </span>
             }
           />
           {fare && (
             <TripDetail
+              description={messages.transitFareDescription}
               icon={<i className='fa fa-money' />}
               summary={fare}
             />
           )}
           {caloriesBurned > 0 && (
             <TripDetail
               icon={<i className='fa fa-heartbeat' />}
-              summary={<span>Calories Burned: <b>{Math.round(caloriesBurned)}</b></span>}
+              summary={<span>{messages.caloriesBurned}: <b>{Math.round(caloriesBurned)}</b></span>}
+              // FIXME: Come up with a way to replace the caloriesBurnedDescription text with
+              // templated strings.
               description={
                 <span>
                   Calories burned is based on <b>{Math.round(walkDuration / 60)} minute(s)</b>{' '}
@@ -147,6 +177,7 @@ class TripDetail extends Component {
 
 const mapStateToProps = (state, ownProps) => {
   return {
+    messages: state.otp.config.language.tripDetails,
     routingType: state.otp.currentQuery.routingType,
     tnc: state.otp.tnc,
     timeFormat: getTimeFormat(state.otp.config),

lib/util/messages.js

@@ -0,0 +1,15 @@
+/**
+ * Takes component's default props and its instance props and returns the
+ * merged messages props. The returned object will ensure that the default
+ * messages are substituted for any translation strings that were missing in the
+ * props. Note: this does not account for messages in nested objects (e.g.,
+ * messages.header.description).
+ */
+export function mergeMessages (defaultProps, props) {
+  const defaultMessages = defaultProps.messages || {}
+  const propsMessages = props.messages || {}
+  return {
+    ...defaultMessages,
+    ...propsMessages
+  }
+}