diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..3174191 --- /dev/null +++ b/.npmignore @@ -0,0 +1,23 @@ +node_modules/ +storybook-static/ +.storybook/ +temp/ +coverage/ + +src/storybook/ + +.idea/ +.vscode/ + +.gitignore + +rollup.config.mjs +jest.config.js +babel.config.js +tsconfig.json + +src/**/*.stories.* +src/**/*.test.* + +secret.txt +diamondlightsource-sci-react-ui*.tgz diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..34ffb7d --- /dev/null +++ b/.npmrc @@ -0,0 +1,2 @@ +publish-branch=main +access=public \ No newline at end of file diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..6bc4ce2 --- /dev/null +++ b/changelog.md @@ -0,0 +1,27 @@ +# Changelog + +## [0.0.1] - 2024-12-19 + +### Added +- Components added: + - Breadcrumbs - Highlight position of page in hierarchy + - ColourSchemeButton - Switch between light and dark schemes. + - Footer - A footer, with logo, menu and copyright + - FooterLinks - A group of links for Footer + - FooterLink - A link for FooterLinks + - ImageColorSchemeSwitch - Allow images to be determined by colour scheme + - Navbar - A header with a menu, and login + - NavbarLinks - a group of menu items for Navbar + - NavbarLink - a menuitem + - ThemeProvider - A provider of a theme + - User - User control, for login, logoff. + - VisitInput - A Input for Diamonds visits/sessions +- Themes added: + - Diamond + - Generic + +### Fixed +- + +### Changed +- \ No newline at end of file diff --git a/package.json b/package.json index ba67d28..358461e 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { "name": "@diamondlightsource/sci-react-ui", "version": "0.0.1", - "description": "A collection of react components based on MUI.", "type": "module", - "author": "DLS", + "description": "A theme and component library to make websites at scientific institutions simple to create.", + "author": "Diamond Light Source", "license": "ISC", "repository": { "type": "git", diff --git a/readme.md b/readme.md index aa72ec3..3bee77f 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,9 @@ Scientific React UI =================== Scientific React UI components, based on MUI. +_Early development release._ + +A theme and component library to make websites at scientific installations simple to create. Using ----- diff --git a/src/styles/colours.ts b/src/styles/colours.ts deleted file mode 100644 index f6d6b35..0000000 --- a/src/styles/colours.ts +++ /dev/null @@ -1,33 +0,0 @@ -// Colours from https://github.com/DiamondLightSource/web-ui-components -import { DiamondTheme } from "../themes/DiamondTheme"; - -const colours = { - diamond: { - 50: { default: "#FBFBFB", _dark: "#525151" }, // white - 75: { default: "#F7F7F7", _dark: "#080808" }, // off white - 100: { default: "#E7ECEF", _dark: "#383838" }, // light grey - 200: { default: "#CBD5E0", _dark: "#030303" }, // mid grey - 300: { default: "#39435E", _dark: "#5f709e" }, // dark blue-grey - 400: { default: "#9BBBFA", _dark: "#030405" }, // light blue - 500: { default: "#fcd021", _dark: "#050401" }, // yellow - 600: { default: "#385BBD", _dark: "#101a36" }, // mid blue - 700: { default: "#1040A1", _dark: "#071d4a" }, // royal blue - 800: { default: "#001d55", _dark: "#023496" }, // dark blue - }, - colours: { - primaryMain: DiamondTheme.palette.primary.main, - primaryLight: DiamondTheme.palette.primary.light, - primaryDark: DiamondTheme.palette.primary.dark, - primaryContrastText: DiamondTheme.palette.primary.contrastText, - secondaryMain: DiamondTheme.palette.secondary.main, - secondaryLight: DiamondTheme.palette.secondary.light, - secondaryDark: DiamondTheme.palette.secondary.dark, - secondaryContrastText: DiamondTheme.palette.secondary.contrastText, - }, -}; - -const fillColours = ["#ff5733", "#19D3FF", "#FF9B40", "#FF2677", "#FF9B40"]; - -const getFillColour = (j: number) => fillColours[j % fillColours.length]; - -export { colours, getFillColour };