Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow multiple transport modes to be specified in a single transportmode #1282

Merged
merged 2 commits into from
Oct 21, 2024
Merged

allow multiple transport modes to be specified in a single transportmode #1282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c100ce
allow multiple transport modes to be specified in a single transportmode
daniel-heppner-ibigroup Oct 8, 2024
0108984
Merge branch 'dev' into allow-multiple-transport-modes
daniel-heppner-ibigroup Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion example-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,11 @@ modes:
iconName: wheelchair
type: CHECKBOX # Possible options: CHECKBOX, SUBMODE, SLIDER, DROPDOWN
transitModes:
- mode: BUS
# Mode can be a string or an array of strings.
- mode: ["TROLLEYBUS", "BUS"]
# When mode is an array an overrideMode must be provided.
# This specifies the displayed mode used for icon and URL param.
overrideMode: BUS
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This key title is confusing. But I can't think of a better one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was trying not to make it a breaking change.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could've done a thing where we just use the first item in the array as the override but this is fine too!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's not a bad idea! we'll see what second reviewer thinks

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name can be confusing at first. Maybe change overrideMode to summaryMode or displayedMode but I don't feel strongly about it. It looks like branded names are already supported, so that should be fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to keep it so we didn't change the config at all. I agree that the name choice wasn't great but I don't think it's worth updating now.

label: Bus
# A mode color can be added, used throughout the application,
# most notably in the enhanced stop viewer bubble
Expand Down
2 changes: 1 addition & 1 deletion lib/actions/form.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export function resetForm(full = false) {
const options = getTripOptionsFromQuery(defaultQuery)
// Default mode is currently WALK,TRANSIT. We need to update this value
// here to match the list of modes, otherwise the form will break.
options.mode = ['WALK', ...transitModes.map((m) => m.mode)].join(',')
options.mode = ['WALK', ...transitModes.flatMap((m) => m.mode)].join(',')
dispatch(settingQueryParam(options))
}
if (full) {
Expand Down
10 changes: 9 additions & 1 deletion lib/reducers/create-otp-reducer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,18 @@ export function getInitialState(userDefinedConfig) {

const transitModeSettings = config?.modes?.transitModes.map((transitMode) => {
const { mode, overrideMode } = transitMode
if (Array.isArray(mode) && !overrideMode) {
console.warn(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When this warning fires the entire app does still crash but I guess the warning is there so that's good enough

`Mode ${mode} is an array, but no overrideMode is specified.`
)
}
const displayedMode = overrideMode || mode
const addTransportModes = Array.isArray(mode)
? mode.map((m) => ({ mode: m }))
: { mode }
return {
// This is the mode that gets added to the actual query to OTP
addTransportMode: { mode },
addTransportMode: addTransportModes,
applicableMode: 'TRANSIT',
default: true,
iconName: displayedMode.toLowerCase(),
Expand Down
2 changes: 1 addition & 1 deletion lib/util/config-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ export interface GeocoderConfig extends GeocoderConfigOtpUI {
export interface TransitModeConfig {
color?: string
label?: string
mode: string
mode: string | string[]
showWheelchairSetting?: boolean
}

Expand Down
Loading