Skip to content

Commit

Permalink
🎉 (entity selector) highlight user location
Browse files Browse the repository at this point in the history
  • Loading branch information
@sophiamersmann
sophiamersmann committed Apr 15, 2024
1 parent 32ad25a commit e956f8d
Show file tree
Hide file tree
Showing 5 changed files with 131 additions and 23 deletions.
3 changes: 1 addition & 2 deletions packages/@ourworldindata/grapher/src/controls/LabeledSwitch.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ export class LabeledSwitch extends React.Component<{
{tooltip && (
<Tippy
content={tooltip}
theme="settings"
theme="grapher-explanation"
placement="top"
// arrow={false}
maxWidth={338}
>
<FontAwesomeIcon icon={faInfoCircle} />
Expand Down
15 changes: 0 additions & 15 deletions packages/@ourworldindata/grapher/src/controls/SettingsMenu.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,21 +112,6 @@ nav.controlsRow .chart-controls .settings-menu {
height: 13px;
padding: 0 0.333em;
}

// the tooltip triggered by hovering the circle-i
@at-root .tippy-box[data-theme="settings"] {
background: white;
color: $dark-text;
font: 400 14px/1.5 $sans-serif-font-stack;
box-shadow: 0px 4px 40px 0px rgba(0, 0, 0, 0.15);

.tippy-content {
padding: $indent;
}
.tippy-arrow {
color: white;
}
}
}

.labeled-switch .labeled-switch-subtitle,
Expand Down
19 changes: 19 additions & 0 deletions packages/@ourworldindata/grapher/src/core/grapher.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,25 @@ $zindex-controls-drawer: 150;
z-index: $zindex-Tooltip;
}

// white background tooltip for longer explanations
// (the `--short` version has a little less padding)
.tippy-box[data-theme="grapher-explanation"],
.tippy-box[data-theme="grapher-explanation--short"] {
background: white;
color: $dark-text;
font: 400 14px/1.5 $sans-serif-font-stack;
box-shadow: 0px 4px 40px 0px rgba(0, 0, 0, 0.15);

.tippy-arrow {
color: white;
}
}
.tippy-box[data-theme="grapher-explanation"] {
.tippy-content {
padding: 15px;
}
}

.markdown-text-wrap__line {
display: block;
}
Expand Down
16 changes: 16 additions & 0 deletions packages/@ourworldindata/grapher/src/entitySelector/EntitySelector.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,22 @@
background: #ebeef2;
z-index: -1;
}

.label-with-location-icon {
display: flex;
align-items: center;

svg {
margin-left: 8px;
font-size: 0.9em;
color: #a1a1a1;

// hide focus outline when clicked
&:focus:not(:focus-visible) {
outline: none;
}
}
}
}

.animated-entity {
Expand Down
101 changes: 95 additions & 6 deletions packages/@ourworldindata/grapher/src/entitySelector/EntitySelector.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,17 @@ import {
CoreValueType,
clamp,
maxBy,
getUserCountryInformation,
regions,
sortBy,
Tippy,
} from "@ourworldindata/utils"
import { Checkbox } from "@ourworldindata/components"
import { FuzzySearch } from "../controls/FuzzySearch"
import {
faCircleXmark,
faMagnifyingGlass,
faLocationArrow,
} from "@fortawesome/free-solid-svg-icons"
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome/index.js"
import { SelectionArray } from "../selection/SelectionArray"
Expand All @@ -41,6 +46,7 @@ import { ColumnSlug } from "@ourworldindata/types"
export interface EntitySelectorState {
searchInput: string
sortConfig: SortConfig
localEntityNames?: string[]
mostRecentlySelectedEntityName?: string
}

Expand All @@ -59,7 +65,7 @@ interface SortConfig {
order: SortOrder
}

type SearchableEntity = { name: string } & Record<
type SearchableEntity = { name: string; local?: boolean } & Record<
ColumnSlug,
CoreValueType | undefined
>
Expand Down Expand Up @@ -89,6 +95,8 @@ export class EntitySelector extends React.Component<{
}

componentDidMount(): void {
void this.populateLocalEntities()

if (this.props.autoFocus && !isTouchDevice())
this.searchField.current?.focus()

Expand Down Expand Up @@ -133,6 +141,32 @@ export class EntitySelector extends React.Component<{
}
}

@action.bound async populateLocalEntities(): Promise<void> {
try {
const localCountryInfo = await getUserCountryInformation()
if (!localCountryInfo) return

const userEntityCodes = [
localCountryInfo.code,
...(localCountryInfo.regions ?? []),
]

const userRegions = regions.filter((region) =>
userEntityCodes.includes(region.code)
)

const sortedUserRegions = sortBy(userRegions, (region) =>
userEntityCodes.indexOf(region.code)
)

const localEntityNames = sortedUserRegions.map(
(region) => region.name
)

if (localEntityNames) this.set({ localEntityNames })
} catch (err) {}
}

private clearSearchInput(): void {
this.set({ searchInput: "" })
}
Expand Down Expand Up @@ -178,6 +212,10 @@ export class EntitySelector extends React.Component<{
)
}

@computed private get localEntityNames(): string[] | undefined {
return this.manager.entitySelectorState.localEntityNames
}

@computed private get table(): OwidTable {
return this.manager.tableForSelection
}
Expand Down Expand Up @@ -252,6 +290,11 @@ export class EntitySelector extends React.Component<{
return this.availableEntityNames.map((entityName) => {
const searchableEntity: SearchableEntity = { name: entityName }

if (this.localEntityNames) {
searchableEntity.local =
this.localEntityNames.includes(entityName)
}

for (const column of this.sortColumns) {
const rows = column.owidRowsByEntityName.get(entityName) ?? []
searchableEntity[column.slug] = maxBy(
Expand All @@ -264,21 +307,46 @@ export class EntitySelector extends React.Component<{
})
}

private sortEntities(entities: SearchableEntity[]): SearchableEntity[] {
private sortEntities(
entities: SearchableEntity[],
options: { sortLocalsToTop: boolean } = { sortLocalsToTop: true }
): SearchableEntity[] {
const { sortConfig } = this

const shouldBeSortedByName =
sortConfig.slug === this.table.entityNameSlug

// sort by name
if (shouldBeSortedByName) {
// sort by name, ignoring local entities
if (shouldBeSortedByName && !options.sortLocalsToTop) {
return orderBy(
entities,
(entity: SearchableEntity) => entity.name,
sortConfig.order
)
}

// sort by name, with local entities at the top
if (shouldBeSortedByName && options.sortLocalsToTop) {
const [localEntities, otherEntities] = partition(
entities,
(entity: SearchableEntity) => entity.local
)

const sortedLocalEntities = sortBy(
localEntities,
(entity: SearchableEntity) =>
this.localEntityNames?.indexOf(entity.name)
)

const sortedOtherEntities = orderBy(
otherEntities,
(entity: SearchableEntity) => entity.name,
sortConfig.order
)

return [...sortedLocalEntities, ...sortedOtherEntities]
}

// sort by number column, with missing values at the end
const [withValues, withoutValues] = partition(
entities,
Expand Down Expand Up @@ -336,7 +404,7 @@ export class EntitySelector extends React.Component<{
)

return {
selected: this.sortEntities(selected),
selected: this.sortEntities(selected, { sortLocalsToTop: false }),
unselected: this.sortEntities(unselected),
}
}
Expand Down Expand Up @@ -473,6 +541,7 @@ export class EntitySelector extends React.Component<{
checked={this.isEntitySelected(entity)}
bar={this.getBarConfigForEntity(entity)}
onChange={() => this.onChange(entity.name)}
local={entity.local}
/>
</li>
))}
Expand All @@ -491,6 +560,7 @@ export class EntitySelector extends React.Component<{
checked={this.isEntitySelected(entity)}
bar={this.getBarConfigForEntity(entity)}
onChange={() => this.onChange(entity.name)}
local={entity.local}
/>
</li>
))}
Expand Down Expand Up @@ -574,6 +644,7 @@ export class EntitySelector extends React.Component<{
onChange={() =>
this.onChange(entity.name)
}
local={entity.local}
/>
</li>
</Flipped>
Expand Down Expand Up @@ -614,6 +685,7 @@ export class EntitySelector extends React.Component<{
onChange={() =>
this.onChange(entity.name)
}
local={entity.local}
/>
</li>
</Flipped>
Expand Down Expand Up @@ -692,18 +764,35 @@ function SelectableEntity({
type,
bar,
onChange,
local,
}: {
name: React.ReactNode
checked: boolean
type: "checkbox" | "radio"
bar?: BarConfig
onChange: () => void
local?: boolean
}) {
const Input = {
checkbox: Checkbox,
radio: RadioButton,
}[type]

const label = local ? (
<span className="label-with-location-icon">
{name}
<Tippy
content="Your current location"
theme="grapher-explanation--short"
placement="top"
>
<FontAwesomeIcon icon={faLocationArrow} />
</Tippy>
</span>
) : (
name
)

return (
<div
className="selectable-entity"
Expand All @@ -717,7 +806,7 @@ function SelectableEntity({
{bar && bar.width !== undefined && (
<div className="bar" style={{ width: `${bar.width * 100}%` }} />
)}
<Input label={name} checked={checked} onChange={onChange} />
<Input label={label} checked={checked} onChange={onChange} />
{bar && (
<span className="value grapher_label-1-medium">
{bar.formattedValue}
Expand Down

0 comments on commit e956f8d

Please sign in to comment.