grafana/public/app/core/components/SharedPreferences/SharedPreferences.tsx
Guilherme Caulada a9faab6b09
Dashboard: Add week start option to global and dashboard preferences (#40010)
* Add global week start option to shared preferences

* Add default_week_start to configuration docs

* Add week start option to dashboards

* Add week start argument to tsdb time range parser

* Fix strict check issues

* Add tests for week start

* Change wording on default_week_start documentation

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update week_start column to be a nullable field

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>

* Update configuration to include browser option

* Update WeekStartPicker container selector

Co-authored-by: Hugo Häggmark <hugo.haggmark@grafana.com>

* Add menuShouldPortal to WeekStartPicker to remove deprecation warning

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

* Add inputId to WeekStartPicker

* Use e2e selector on WeekStartPicker aria-label

* Simplify WeekStartPicker onChange condition

* Specify value type on WeekStartPicker weekStarts

* Remove setWeekStart side effect from reducer

* Fix updateLocale failing to reset week start

* Store week start as string to handle empty values

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
Co-authored-by: Hugo Häggmark <hugo.haggmark@grafana.com>
Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
2021-10-18 10:27:14 -03:00

198 lines
5.6 KiB
TypeScript

import React, { PureComponent } from 'react';
import { css } from '@emotion/css';
import {
Button,
Field,
FieldSet,
Form,
Icon,
Label,
RadioButtonGroup,
Select,
stylesFactory,
TimeZonePicker,
WeekStartPicker,
Tooltip,
} from '@grafana/ui';
import { SelectableValue } from '@grafana/data';
import { selectors } from '@grafana/e2e-selectors';
import { DashboardSearchHit, DashboardSearchItemType } from 'app/features/search/types';
import { backendSrv } from 'app/core/services/backend_srv';
import { PreferencesService } from 'app/core/services/PreferencesService';
export interface Props {
resourceUri: string;
}
export interface State {
homeDashboardId: number;
theme: string;
timezone: string;
weekStart: string;
dashboards: DashboardSearchHit[];
}
const themes: SelectableValue[] = [
{ value: '', label: 'Default' },
{ value: 'dark', label: 'Dark' },
{ value: 'light', label: 'Light' },
];
export class SharedPreferences extends PureComponent<Props, State> {
service: PreferencesService;
constructor(props: Props) {
super(props);
this.service = new PreferencesService(props.resourceUri);
this.state = {
homeDashboardId: 0,
theme: '',
timezone: '',
weekStart: '',
dashboards: [],
};
}
async componentDidMount() {
const prefs = await this.service.load();
const dashboards = await backendSrv.search({ starred: true });
const defaultDashboardHit: DashboardSearchHit = {
id: 0,
title: 'Default',
tags: [],
type: '' as DashboardSearchItemType,
uid: '',
uri: '',
url: '',
folderId: 0,
folderTitle: '',
folderUid: '',
folderUrl: '',
isStarred: false,
slug: '',
items: [],
};
if (prefs.homeDashboardId > 0 && !dashboards.find((d) => d.id === prefs.homeDashboardId)) {
const missing = await backendSrv.search({ dashboardIds: [prefs.homeDashboardId] });
if (missing && missing.length > 0) {
dashboards.push(missing[0]);
}
}
this.setState({
homeDashboardId: prefs.homeDashboardId,
theme: prefs.theme,
timezone: prefs.timezone,
weekStart: prefs.weekStart,
dashboards: [defaultDashboardHit, ...dashboards],
});
}
onSubmitForm = async () => {
const { homeDashboardId, theme, timezone, weekStart } = this.state;
await this.service.update({ homeDashboardId, theme, timezone, weekStart });
window.location.reload();
};
onThemeChanged = (value: string) => {
this.setState({ theme: value });
};
onTimeZoneChanged = (timezone?: string) => {
if (!timezone) {
return;
}
this.setState({ timezone: timezone });
};
onWeekStartChanged = (weekStart: string) => {
this.setState({ weekStart: weekStart });
};
onHomeDashboardChanged = (dashboardId: number) => {
this.setState({ homeDashboardId: dashboardId });
};
getFullDashName = (dashboard: SelectableValue<DashboardSearchHit>) => {
if (typeof dashboard.folderTitle === 'undefined' || dashboard.folderTitle === '') {
return dashboard.title;
}
return dashboard.folderTitle + ' / ' + dashboard.title;
};
render() {
const { theme, timezone, weekStart, homeDashboardId, dashboards } = this.state;
const styles = getStyles();
return (
<Form onSubmit={this.onSubmitForm}>
{() => {
return (
<FieldSet label="Preferences">
<Field label="UI Theme">
<RadioButtonGroup
options={themes}
value={themes.find((item) => item.value === theme)?.value}
onChange={this.onThemeChanged}
/>
</Field>
<Field
label={
<Label htmlFor="home-dashboard-select">
<span className={styles.labelText}>Home Dashboard</span>
<Tooltip content="Not finding the dashboard you want? Star it first, then it should appear in this select box.">
<Icon name="info-circle" />
</Tooltip>
</Label>
}
aria-label="User preferences home dashboard drop down"
>
<Select
menuShouldPortal
value={dashboards.find((dashboard) => dashboard.id === homeDashboardId)}
getOptionValue={(i) => i.id}
getOptionLabel={this.getFullDashName}
onChange={(dashboard: SelectableValue<DashboardSearchHit>) =>
this.onHomeDashboardChanged(dashboard.id)
}
options={dashboards}
placeholder="Choose default dashboard"
inputId="home-dashboard-select"
/>
</Field>
<Field label="Timezone" aria-label={selectors.components.TimeZonePicker.container}>
<TimeZonePicker includeInternal={true} value={timezone} onChange={this.onTimeZoneChanged} />
</Field>
<Field label="Week start" aria-label={selectors.components.WeekStartPicker.container}>
<WeekStartPicker value={weekStart} onChange={this.onWeekStartChanged} />
</Field>
<div className="gf-form-button-row">
<Button variant="primary" aria-label="User preferences save button">
Save
</Button>
</div>
</FieldSet>
);
}}
</Form>
);
}
}
export default SharedPreferences;
const getStyles = stylesFactory(() => {
return {
labelText: css`
margin-right: 6px;
`,
};
});