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

feat: Custom header and footer. Move settings to its own page #17

Merged
merged 8 commits into from
Jan 9, 2025
+425 −191
Merged

feat: Custom header and footer. Move settings to its own page #17

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6f2a2bf
feat: Add custom header and footer. Hide dhis HeaderBar for non-admin…
MatiasArriola Dec 31, 2024
629d925
feat: Move settings to its own page, just for Admins
MatiasArriola Dec 31, 2024
d3195d5
fix: Moved config options to readme instead of having commented code
MatiasArriola Jan 7, 2025
1780c98
fix: check for admin in SaveSettingsUseCase
MatiasArriola Jan 8, 2025
0bef823
fix: avoid i18n namespace error when using ":" in translation key
MatiasArriola Jan 8, 2025
8f379cb
Merge branch 'feat/ntd-customizations' into feat/header-footer-settin…
MatiasArriola Jan 8, 2025
5df528b
fix: i18n duplicated keys
MatiasArriola Jan 8, 2025
4d5f71d
refactor: extract function getSettingsOrInitialize
MatiasArriola Jan 9, 2025
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,3 +181,7 @@ Now you can start the server and check if every visualization is working properl
### Storage

Settings can be saved in the data store (default) or as constants. Use the env variable **REACT_APP_STORAGE** to select which one to use (`datastore` or `constants`).

### Custom Header and Footer

The header and footer can be configured in `src/app-config.ts`. They can be disabled by setting their values to `false`.
15 changes: 9 additions & 6 deletions i18n/ar.po
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: i18next-conv\n"
"POT-Creation-Date: 2024-12-16T17:57:18.316Z\n"
"POT-Creation-Date: 2024-12-31T16:17:51.096Z\n"
"PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
Expand All @@ -26,19 +26,16 @@ msgstr ""
msgid "Export to Word"
msgstr ""

msgid "App Settings"
msgstr ""

msgid "Font Size"
msgstr ""

msgid "Show/Hide Feedback"
msgstr ""

msgid "Save"
msgid "Cancel"
msgstr ""

msgid "Close"
msgid "Save"
msgstr ""

msgid "Back"
Expand All @@ -53,6 +50,9 @@ msgstr ""
msgid "Templates not found"
msgstr ""

msgid "Settings saved"
msgstr ""

msgid "Distributed under GNU GLPv3"
msgstr ""

Expand Down Expand Up @@ -81,3 +81,6 @@ msgstr ""

msgid "EyeSeeTea"
msgstr ""

msgid "App Settings"
msgstr ""
17 changes: 10 additions & 7 deletions i18n/en.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ msgstr ""
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
"POT-Creation-Date: 2024-12-16T17:57:18.316Z\n"
"PO-Revision-Date: 2024-12-16T17:57:18.316Z\n"
"POT-Creation-Date: 2024-12-31T16:17:51.096Z\n"
"PO-Revision-Date: 2024-12-31T16:17:51.096Z\n"

msgid "Select Dashboard"
msgstr ""
Expand All @@ -26,19 +26,16 @@ msgstr ""
msgid "Export to Word"
msgstr ""

msgid "App Settings"
msgstr ""

msgid "Font Size"
msgstr ""

msgid "Show/Hide Feedback"
msgstr ""

msgid "Save"
msgid "Cancel"
msgstr ""

msgid "Close"
msgid "Save"
msgstr ""

msgid "Back"
Expand All @@ -53,6 +50,9 @@ msgstr ""
msgid "Templates not found"
msgstr ""

msgid "Settings saved"
msgstr ""

msgid "Distributed under GNU GLPv3"
msgstr ""

Expand Down Expand Up @@ -81,3 +81,6 @@ msgstr ""

msgid "EyeSeeTea"
msgstr ""

msgid "App Settings"
msgstr ""
15 changes: 9 additions & 6 deletions i18n/es.po
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: i18next-conv\n"
"POT-Creation-Date: 2024-12-16T17:57:18.316Z\n"
"POT-Creation-Date: 2024-12-31T16:17:51.096Z\n"
"PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
Expand All @@ -26,19 +26,16 @@ msgstr ""
msgid "Export to Word"
msgstr ""

msgid "App Settings"
msgstr ""

msgid "Font Size"
msgstr ""

msgid "Show/Hide Feedback"
msgstr ""

msgid "Save"
msgid "Cancel"
msgstr ""

msgid "Close"
msgid "Save"
msgstr ""

msgid "Back"
Expand All @@ -53,6 +50,9 @@ msgstr ""
msgid "Templates not found"
msgstr ""

msgid "Settings saved"
msgstr ""

msgid "Distributed under GNU GLPv3"
msgstr ""

Expand Down Expand Up @@ -82,6 +82,9 @@ msgstr ""
msgid "EyeSeeTea"
msgstr ""

msgid "App Settings"
msgstr ""

#~ msgid "Add"
#~ msgstr "Añadir"

Expand Down
15 changes: 9 additions & 6 deletions i18n/fr.po
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: i18next-conv\n"
"POT-Creation-Date: 2024-12-16T17:57:18.316Z\n"
"POT-Creation-Date: 2024-12-31T16:17:51.096Z\n"
"PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
Expand All @@ -26,19 +26,16 @@ msgstr ""
msgid "Export to Word"
msgstr ""

msgid "App Settings"
msgstr ""

msgid "Font Size"
msgstr ""

msgid "Show/Hide Feedback"
msgstr ""

msgid "Save"
msgid "Cancel"
msgstr ""

msgid "Close"
msgid "Save"
msgstr ""

msgid "Back"
Expand All @@ -53,6 +50,9 @@ msgstr ""
msgid "Templates not found"
msgstr ""

msgid "Settings saved"
msgstr ""

msgid "Distributed under GNU GLPv3"
msgstr ""

Expand Down Expand Up @@ -81,3 +81,6 @@ msgstr ""

msgid "EyeSeeTea"
msgstr ""

msgid "App Settings"
msgstr ""
15 changes: 9 additions & 6 deletions i18n/pt.po
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: i18next-conv\n"
"POT-Creation-Date: 2024-12-16T17:57:18.316Z\n"
"POT-Creation-Date: 2024-12-31T16:17:51.096Z\n"
"PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
Expand All @@ -26,19 +26,16 @@ msgstr ""
msgid "Export to Word"
msgstr ""

msgid "App Settings"
msgstr ""

msgid "Font Size"
msgstr ""

msgid "Show/Hide Feedback"
msgstr ""

msgid "Save"
msgid "Cancel"
msgstr ""

msgid "Close"
msgid "Save"
msgstr ""

msgid "Back"
Expand All @@ -53,6 +50,9 @@ msgstr ""
msgid "Templates not found"
msgstr ""

msgid "Settings saved"
msgstr ""

msgid "Distributed under GNU GLPv3"
msgstr ""

Expand Down Expand Up @@ -81,3 +81,6 @@ msgstr ""

msgid "EyeSeeTea"
msgstr ""

msgid "App Settings"
msgstr ""
28 changes: 28 additions & 0 deletions src/app-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,40 @@ export const appConfig: AppConfig = {
buttonPosition: "bottom-end",
},
},
header: false,
footer: false,
// header: {
MatiasArriola marked this conversation as resolved.
Show resolved Hide resolved
// title: "Dashboard Reports - Custom Header Title",
// background: "rgba(19,52,59,1)",
// color: "white",
// },
// footer: {
// text: `Dashboard Reports - Custom Footer.
// Multi-line text is allowed.
// TBD: More customization options.
// `,
// background: "linear-gradient(90deg, rgba(31,41,30,1) 0%, rgba(20,50,28,1) 50%, rgba(31,41,30,1) 100%)",
// color: "white",
// },
};

export interface HeaderOptions {
title: string;
background?: string;
color?: string;
}
export interface FooterOptions {
text: string;
background?: string;
color?: string;
}

export interface AppConfig {
appKey: string;
appearance: {
showShareButton: boolean;
};
feedback?: FeedbackOptions;
header: HeaderOptions | false;
footer: FooterOptions | false;
}
28 changes: 28 additions & 0 deletions src/webapp/components/custom-footer/CustomFooter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import React from "react";
import { Typography, Box, makeStyles } from "@material-ui/core";
import { FooterOptions } from "../../../app-config";

export type CustomFooterProps = FooterOptions;

type StyleProps = Omit<CustomFooterProps, "text">;

const useStyles = makeStyles(() => ({
container: (props: StyleProps) => ({
background: props.background ?? "inherit",
color: props.color ?? "inherit",
}),
text: {
whiteSpace: "pre-line",
},
}));

export const CustomFooter: React.FC<CustomFooterProps> = ({ text, ...styleProps }) => {
const classes = useStyles(styleProps);
return (
<Box component="footer" py={4} px={6} className={classes.container}>
<Typography variant="body2" className={classes.text}>
{text}
</Typography>
</Box>
);
};
34 changes: 34 additions & 0 deletions src/webapp/components/custom-header/CustomHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from "react";
import AppBar from "@material-ui/core/AppBar";
import Toolbar from "@material-ui/core/Toolbar";
import Typography from "@material-ui/core/Typography";
import { makeStyles } from "@material-ui/core/styles";
import { HeaderOptions } from "../../../app-config";

export type CustomHeaderProps = HeaderOptions;

type StyleProps = Omit<CustomHeaderProps, "title">;

const useStyles = makeStyles(() => ({
container: (props: StyleProps) => ({
background: props.background ?? "inherit",
color: props.color ?? "inherit",
}),
title: {
flexGrow: 1,
},
}));

export const CustomHeader: React.FC<CustomHeaderProps> = ({ title, ...styleProps }) => {
const classes = useStyles(styleProps);

return (
<AppBar position="static" className={classes.container} elevation={0}>
<Toolbar>
<Typography variant="h6" className={classes.title}>
{title}
</Typography>
</Toolbar>
</AppBar>
);
};
Loading
Loading