@koine/react 1.0.3 → 1.0.8

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "@koine/react",
   "sideEffects": false,
-  "version": "1.0.3",
+  "dependencies": {
+    "@types/react": "^17.0.0 || ^18.0.0",
+    "@types/react-dom": "^17.0.0 || ^18.0.0",
+    "@types/react-is": "^17.0.0 || ^18.0.0",
+    "@types/styled-components": "^5.1.25",
+    "@types/yup": "^0.29.13"
+  },
+  "version": "1.0.8",
   "main": "./index.umd.js",
-  "module": "./index.esm.js",
+  "module": "./index.js",
   "typings": "./index.d.ts",
-  "dependencies": {
+  "peerDependencies": {
     "styled-components": "^5.3.5",
     "framer-motion": "^6.2.9",
-    "react": "^17.0.2",
-    "@mui/base": "^5.0.0-alpha.75",
-    "@koine/utils": "1.0.3",
-    "@react-icons/all-files": "^4.1.0",
+    "react": ">=17.0.2 || >=18.0.0",
+    "@mui/base": "^5.0.0-alpha.76",
+    "@koine/utils": "1.0.8",
+    "react-icons": "^4.3.1",
     "date-fns": "^2.28.0",
     "react-swipeable": "^6.2.1",
     "@reach/disclosure": "^0.16.2",
@@ -23,6 +30,5 @@
     "@n8tb1t/use-scroll-position": "^2.0.3",
     "react-use": "^17.3.2",
     "@reach/tabs": "^0.16.4"
-  },
-  "peerDependencies": {}
+  }
 }

package/styles/Body.js

@@ -0,0 +1,17 @@
+import styled from "styled-components";
+export const BodyRoot = styled.div `
+  display: flex;
+  flex-direction: column;
+  min-height: 100vh;
+`;
+/**
+ * If you have background graphics to overlap you might need to add:
+ *
+ * ```css
+ * z-index: 1;
+ * position: relative;
+ * ```
+ */
+export const BodyMain = styled.main `
+  flex: 1;
+`;

package/styles/Global.js

@@ -0,0 +1,50 @@
+import { createGlobalStyle } from "styled-components";
+/**
+ * App global style
+ *
+ * For examples of what to do here take a look at [Bootstrap's reset](https://github.com/twbs/bootstrap/blob/main/scss/_reboot.scss)
+ * and similar.
+ *
+ * What we do here:
+ * - set the base font family on all possible elements including placeholders prevent Chrome showing a standard font when using the autofill feature
+ *  - @see https://stackoverflow.com/a/60987373/1938970
+ * - set the base font size on all possible elements to prevent weird zooming on input fields on iPhone iOS devices.
+ *  - @see https://www.warrenchandler.com/2019/04/02/stop-iphones-from-zooming-in-on-form-fields/
+ *  - @see https://css-tricks.com/16px-or-larger-text-prevents-ios-form-zoom/
+ */
+export const stylesGlobal = `
+  body {
+    margin: 0;
+    padding: 0;
+    overflow-x: hidden;
+    overflow-y: scroll;
+  }
+
+  body,
+  button,
+  input,
+  textarea,
+  select,
+  select:-webkit-autofill::first-line,
+  input:-webkit-autofill::first-line {
+    font-family: var(--font), -apple-system, BlinkMacSystemFont, "Segoe UI",
+      Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue",
+      sans-serif;
+    font-size: var(--fontSize);
+  }
+
+  html {
+    box-sizing: border-box;
+    @media (prefers-reduced-motion: no-preference) {
+      scroll-behavior: smooth;
+    }
+  }
+
+  *,
+  *:before,
+  *:after {
+    box-sizing: inherit;
+    -webkit-tap-highlight-color: transparent;
+  }
+`;
+export const StylesGlobal = createGlobalStyle `${stylesGlobal}`;

package/styles/classed.js

@@ -0,0 +1,11 @@
+import { createElement } from "react";
+/**
+ * Adapted (removed `classnames` dependency) from:
+ * @see https://daily.dev/blog/my-tailwind-css-utility-function-for-creating-reusable-react-components-typescript-support
+ */
+function classed(type, ...className) {
+    return function Classed(props) {
+        return createElement(type, Object.assign(Object.assign({}, props), { className: [(props === null || props === void 0 ? void 0 : props.className) || ""].concat(className).join(" ") }));
+    };
+}
+export default classed;

package/styles/index.js

@@ -0,0 +1,7 @@
+export * from "./Body";
+export * from "./Global";
+export * from "./media";
+export * from "./spacing";
+export * from "./styled";
+export * from "./theme";
+export * from "./theme--vanilla";

package/styles/media.js

@@ -0,0 +1,150 @@
+import { useState, useEffect } from "react";
+import { useTheme, breakpoints } from "./theme";
+export const { min, max, up, down, between, only } = generateMediaQueries(breakpoints);
+export function useMedia(media) {
+    const { breakpoints } = useTheme();
+    const [matches, setMatches] = useState(false);
+    const [direction = "min", breakpoint] = media.split(":");
+    let px = breakpoints[breakpoint];
+    if (direction === "max") {
+        px = px - 0.02;
+    }
+    const query = `(${direction}-width: ${px}px)`;
+    useEffect(() => {
+        const mq = window.matchMedia(query);
+        const handleChange = (event) => {
+            setMatches(event.matches);
+        };
+        setMatches(mq.matches);
+        // Safari < 14 can't use addEventListener on a MediaQueryList
+        // https://developer.mozilla.org/en-US/docs/Web/API/MediaQueryList#Browser_compatibility
+        if (!mq.addEventListener) {
+            // Update the state whenever the media query match state changes
+            mq.addListener(handleChange);
+            // Clean up on unmount and if the query changes
+            return () => {
+                mq.removeListener(handleChange);
+            };
+        }
+        mq.addEventListener("change", handleChange);
+        return () => {
+            mq.removeEventListener("change", handleChange);
+        };
+    }, [query]);
+    return matches;
+}
+/**
+ * Generate media queries helpers
+ *
+ * Usage:
+ * ```jsx
+ * import { generateMediaQueries } from "@koine/react";
+ *
+ * export const breakpoints = {
+ *   xs: 0,
+ *   sm: 440,
+ *   md: 768,
+ *   lg: 1024,
+ *   xl: 1368,
+ *   xxl: 1690,
+ * } as const;
+ *
+ * export const { min, max, up, down, between, only } = generateMediaQueries(breakpoints);
+ * ```
+ *
+ * Consider the following syntaxes, using normal CSS is just slightly
+ * longer but it aovid js imports, reduce the js overhead and improve CSS
+ * highlighting in the editor.
+ *
+ * Even if we would reduce the function signature to the bare minimum the advantage
+ * in terms of typing would not be much, also loosing in readability.
+ *
+ * ```css
+ * // but unfortunately this does not work
+ * @media (min-width: var(--b-sm)) {}
+ * @media (min-width: 480px) {}
+ *
+ * ${media("min", "sm")} {}
+ * ${mediaMin("sm")} {}
+ * ${min.sm} {}
+ * ${p => p.theme.min.sm}``
+ * ```
+ *
+ * Related projects:
+ * @see https://github.com/mg901/styled-breakpoints
+ * @see https://github.com/morajabi/styled-media-query
+ *
+ * @see https://www.w3.org/TR/mediaqueries-5/#custom-mq The spec would allow for
+ * something like this syntax
+ *
+ * ```css
+ * @custom-media --narrow-window (max-width: 30em);
+ * @media (--narrow-window) {}
+ * ```
+ */
+export function generateMediaQueries(breakpoints) {
+    const temp = Object.keys(breakpoints).map((key) => {
+        const br = key;
+        return [br, breakpoints[br]];
+    });
+    const sortedKeys = temp.sort((a, b) => a[1] - b[1]).map((item) => item[0]);
+    const getNext = (breakpoint) => {
+        const index = sortedKeys.indexOf(breakpoint);
+        return sortedKeys[index + 1];
+    };
+    /**
+     * It behaves the same as `@media (min-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `min("md")` and as an
+     * object literal `min.md`.
+     */ // @ts-expect-error FIXME: at some point
+    const min = (br) => `@media (min-width: ${breakpoints[br]}px)`;
+    /**
+     * It behaves the same as `@media (max-width: ${value}px)`
+     * where value is the given breakpoint value.
+     * For ease of use this can be used both as a function `max("md")` and as an
+     * object literal `max.md`.
+     */ // @ts-expect-error FIXME: at some point
+    const max = (br) => `@media (max-width: ${breakpoints[br] - 0.02}px)`;
+    for (const br in breakpoints) {
+        const _br = br;
+        min[_br] = `@media (min-width: ${breakpoints[_br]}px)`;
+        max[_br] = `@media (max-width: ${breakpoints[_br] - 0.02}px)`;
+    }
+    /**
+     * It behaves the same as `min`
+     * @inheritdoc {max}
+     */
+    const up = min;
+    /**
+     * It behaves similarly to `max` but you will use the "next" breakpoint,
+     * specifying CSS that will apply from the given breakpoint and down.
+     */
+    const down = (br) => {
+        const brNext = getNext(br);
+        // TODO: if br does not exists otherwise throw Error
+        return brNext && `@media (max-width: ${breakpoints[brNext] - 0.02}px)`;
+    };
+    /**
+     * Media query between the two given breakpoints
+     */
+    const between = (br1, br2) => {
+        return `@media (min-width: ${breakpoints[br1]}px) and (max-width: ${breakpoints[br2] - 0.02}px)`;
+    };
+    /**
+     * Media query to apply from the given breakpoint until the next, just for its
+     * full range
+     */
+    const only = (br) => {
+        const brNext = getNext(br);
+        return brNext ? between(br, brNext) : min(br);
+    };
+    return {
+        min,
+        max,
+        up,
+        down,
+        between,
+        only,
+    };
+}

package/styles/spacing.d.ts

@@ -1,13 +1,13 @@
-import type { Theme } from "./theme";
+import type { DefaultTheme } from "styled-components";
 export declare type SpacingSize = "sm" | "md" | "lg";
 export declare type SpacingProperty = "padding" | "margin";
 /** @default 1 */
 export declare type SpacingFactor = number;
 export declare type SpacingDirection = "top" | "bottom";
 export declare type SpacingDirectionAxis = "vertical" | SpacingDirection;
-export declare type SpacingDevices = keyof Theme["devices"];
+export declare type SpacingDevices = keyof DefaultTheme["devices"];
 export declare type SpacingArgs = Parameters<typeof spacing>;
-export declare function spacing(this: Theme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, direction?: SpacingDirectionAxis, devices?: SpacingDevices[]): string;
-export declare function spacingTop(this: Theme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;
-export declare function spacingBottom(this: Theme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;
-export declare function spacingVertical(this: Theme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;
+export declare function spacing(this: DefaultTheme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, direction?: SpacingDirectionAxis, devices?: SpacingDevices[]): string;
+export declare function spacingTop(this: DefaultTheme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;
+export declare function spacingBottom(this: DefaultTheme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;
+export declare function spacingVertical(this: DefaultTheme, size?: SpacingSize, factor?: SpacingFactor, property?: SpacingProperty, devices?: SpacingDevices[]): string;

package/styles/spacing.js

@@ -0,0 +1,46 @@
+function _spacing(theme, size = "md", factor = 1, property = "padding", direction = "top", devices = ["mobile", "tablet", "desktop"]) {
+    const { breakpoints, devices: DEVICES, spaces: SPACES } = theme;
+    let css = "";
+    const prop = `${property}-${direction}`;
+    if (devices === ["mobile"]) {
+        css += `@media(max-width: ${breakpoints[DEVICES.mobile]}px){
+        ${prop}: ${SPACES["mobile"][size] * factor}px;
+      }`;
+    }
+    else {
+        for (let index = 0; index < devices.length; index++) {
+            const device = devices[index];
+            if (device === "mobile") {
+                css += `${prop}: ${SPACES[device][size] * factor}px;`;
+            }
+            else if (device === "tablet") {
+                css += `@media(min-width: ${breakpoints[DEVICES.tablet]}px){
+          ${prop}: ${SPACES["tablet"][size] * factor}px;
+        }`;
+            }
+            else if (device === "desktop") {
+                css += `@media(min-width: ${breakpoints[DEVICES.desktop]}px){
+          ${prop}: ${SPACES["desktop"][size] * factor}px;
+        }`;
+            }
+        }
+    }
+    return css;
+}
+export function spacing(size, factor, property, direction, devices) {
+    if (direction === "vertical") {
+        return (_spacing(this, size, factor, property, "top", devices) +
+            _spacing(this, size, factor, property, "bottom", devices));
+    }
+    return _spacing(this, size, factor, property, direction, devices);
+}
+export function spacingTop(size, factor, property, devices) {
+    return _spacing(this, size, factor, property, "top", devices);
+}
+export function spacingBottom(size, factor, property, devices) {
+    return _spacing(this, size, factor, property, "bottom", devices);
+}
+export function spacingVertical(size, factor, property, devices) {
+    return (_spacing(this, size, factor, property, "top", devices) +
+        _spacing(this, size, factor, property, "bottom", devices));
+}

package/styles/styled.d.ts

@@ -1,5 +1,5 @@
-import type { Theme } from "./theme";
-export declare function colStretch(this: Theme, direction: "left" | "right", color: keyof Readonly<Theme> | string): string;
+import React from "react";
+export declare function colStretch(direction: "left" | "right", bg: React.CSSProperties["background"]): string;
 /** @see https://caniuse.com/?search=inset */
 export declare const inset0 = "top:0;left:0;right:0;bottom:0;";
 export declare const overlay: string;

package/styles/styled.js

@@ -0,0 +1,27 @@
+export function colStretch(direction, bg) {
+    return `
+    background: ${bg};
+    position: relative;
+
+    &:before{
+      z-index: -1;
+      content: '';
+      position: absolute;
+      right: ${direction === "left" ? "100%" : "-100vw"};
+      left: ${direction === "right" ? "100%" : "-100vw"};
+      top: 0;
+      bottom: 0;
+      background: ${bg};
+    }
+  `;
+}
+/** @see https://caniuse.com/?search=inset */
+export const inset0 = `top:0;left:0;right:0;bottom:0;`;
+export const overlay = `position: absolute;${inset0}`;
+export const centered = `display: flex;align-items: center;justify-content: center;`;
+export const ellipsis = `overflow: hidden;text-overflow: ellipsis;white-space: nowrap;`;
+/**
+ * @see import("@mui/utils").visuallyHidden https://github.com/mui-org/material-ui/blob/master/packages/mui-utils/src/visuallyHidden.ts
+ */
+export const invisible = `border: 0;clip: rect(0 0 0 0);height: 1px;margin: -1px;overflow: hidden;padding: 0;position: absolute;white-space: nowrap;width: 1px;`;
+export const stateFocus = `outline: 0px;box-shadow: 0 0 0 0.2rem rgba(200, 200, 200, 0.25);`;

package/styles/theme--vanilla.js

@@ -0,0 +1,53 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { createContext, useState } from "react";
+import { isBrowser, setCookie, parseCookie } from "@koine/utils";
+import { useMount, useUpdateEffect } from "react-use";
+export const THEME_KEY = "theme";
+export const THEME_DEFAULT = "light";
+export const getInitialThemeFromRequest = (cookie) => {
+    if (cookie) {
+        const parsed = parseCookie(cookie);
+        return parsed === null || parsed === void 0 ? void 0 : parsed.theme;
+    }
+    return THEME_DEFAULT;
+};
+export const getInitialThemeFromClient = () => {
+    if (typeof window !== "undefined" && window.localStorage) {
+        const storedPrefs = window.localStorage.getItem(THEME_KEY);
+        if (typeof storedPrefs === "string") {
+            return storedPrefs;
+        }
+        const userMedia = window.matchMedia("(prefers-color-scheme: dark)");
+        if (userMedia.matches) {
+            return "dark";
+        }
+    }
+    return THEME_DEFAULT;
+};
+export const ThemeVanillaContext = createContext({
+    theme: "light",
+    setTheme: undefined,
+});
+export const ThemeVanillaProvider = ({ initialTheme, children, }) => {
+    const [theme, setTheme] = useState(initialTheme);
+    const rawSetTheme = (rawTheme) => {
+        if (!rawTheme || !isBrowser) {
+            return;
+        }
+        const root = window.document.documentElement;
+        const isDark = rawTheme === "dark";
+        root.classList.remove(isDark ? "light" : "dark");
+        root.classList.add(rawTheme);
+        localStorage.setItem(THEME_KEY, rawTheme);
+        setCookie(THEME_KEY, rawTheme);
+    };
+    useMount(() => {
+        const theme = getInitialThemeFromClient();
+        setTheme(theme);
+        rawSetTheme(theme);
+    });
+    useUpdateEffect(() => {
+        rawSetTheme(theme);
+    }, [theme]);
+    return (_jsx(ThemeVanillaContext.Provider, Object.assign({ value: { theme, setTheme } }, { children: children })));
+};

package/styles/theme.d.ts

@@ -1,5 +1,3 @@
-import { spacing, spacingTop, spacingBottom, spacingVertical } from "./spacing";
-import { colStretch } from "./styled";
 export declare type Breakpoint = "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
 export declare type Breakpoints = Record<Breakpoint, number>;
 /**
@@ -74,11 +72,6 @@ export declare type Theme = {
         /** @default [70, 70] */
         logoWidthSticky: [number, number];
     };
-    spacing: typeof spacing;
-    spacingTop: typeof spacingTop;
-    spacingBottom: typeof spacingBottom;
-    spacingVertical: typeof spacingVertical;
-    colStretch: typeof colStretch;
 };
 export declare type ThemeOptions = {
     maxWidth?: number;

package/styles/theme.js

@@ -0,0 +1,38 @@
+import { useTheme as _useTheme } from "styled-components";
+const DEFAULT_BREAKPOINTS = {
+    xs: 0,
+    sm: 440,
+    md: 768,
+    lg: 1024,
+    xl: 1368,
+    xxl: 1690,
+};
+/**
+ * You can override the default breakpoints through the .env variable
+ *
+ * FIXME: find a better way to configure it, the problem is that we use the media
+ * queries within this pre-compiled library and thrught it was better to avoid
+ * using theming props for a more ergonomic usage.
+ *
+ * ```.env
+ * BREAKPOINTS=xs:0,sm:440,md:768,lg:1024,xl:1368,xxl:1690
+ * ```
+ */
+export const breakpoints = process.env["BREAKPOINTS"]
+    ? process.env["BREAKPOINTS"].split(",").reduce((map, pair) => {
+        const [key, value] = pair.split(":");
+        map[key] = parseFloat(value);
+        return map;
+    }, {})
+    : DEFAULT_BREAKPOINTS;
+const themeDefault = {
+    maxWidth: breakpoints.xxl,
+    breakpoints,
+    devices: {
+        mobile: "sm",
+        tablet: "md",
+        desktop: "lg",
+    },
+};
+export const createTheme = (options) => (Object.assign(Object.assign({}, themeDefault), options));
+export const useTheme = _useTheme;

package/types.js

@@ -0,0 +1 @@
+export {};

package/typings.d.ts

@@ -0,0 +1,21 @@
+import "styled-components";
+// import type {} from "styled-components/cssprop"; // for `css` prop
+
+/**
+ * Styled components utility types
+ */
+type Theme = import("./styles/theme").Theme;
+
+declare module "styled-components" {
+  // extends the global DefaultTheme with our ThemeType.
+  export interface DefaultTheme extends Theme {
+    maxWidth: number;
+  }
+}
+
+/**
+ * Types specifically related to `@koine/react` exposed on the global unique
+ * namespace `Koine`. Most of the types here should be prefixed by `React`, e.g.
+ * `ReactSomeFeature` accessible anywhere from `Koine.ReactSomeFeature`
+ */
+declare namespace Koine {}