aidos-ui 3.0.0

package/src/pages/index.mdx

@@ -0,0 +1,58 @@
+# Aidos UI
+
+This is a React design system library with many utilities and zero dependencies. It was built with the aim to be simple, lightweight and beautiful.
+
+- [Why](/#why)
+- [Who is this for](/#who-is-this-for)
+- [Design philosophy](/#design-philosophy)
+- [Installation](/#installation)
+- [How to use](/#how-to-use)
+
+## Why?
+
+Over the years I have always have many side projects, and many of them needed a UI. I disliked every available library because they had so much code to support many cases I did not care about. Back in 2019 I thought, maybe I could make my own design system, with just enough javascript to do things exactly how I wanted them to be, and so I did. Since then it has changed quite a bit and it is now something I am more or less proud of. It has everything I have ever needed and it is done in the way I find simplest and least convoluted. This is all ultimately very subjective, and that is fine, because the first design decision of this library was that it would be extremely opinionated. With that said, although this library does not lend it self to modification, it does tend to be fairly easy to extend and compose with it. I am now making this documentation with the vague weak conviction that someone out there may benefit from it. I still dislike other design libraries not because they are not capable but becuse they are too general purpose. I wanted this library to be not-general purpose, but if this happens to fit your needs, it should be the lightest and simplest option available. This will not try to solve all your problems but it will solve a few problems really well.
+
+---
+
+## Who is this for?
+
+I initially only planned to use this myself so its features and design have so far reflected the things I have been working on. However I keep extending this library, and I think that with more users it may be possible to add more ideas and usecases so that this becomes a really complete system.
+
+---
+
+## Design philosophy
+
+1. <b>Opinionated</b>
+
+First and foremost, this library is extremely opinionated. This is so because I believe HTML is too low level and error prone, CSS defaults are not beautiful enough, and the web in general too big a toolkit to make simple things work in the way you expect. So, for the sake of simplicity, this library imposes opinions at every step. These opinions will not fit everyone's needs, and that is a sacrifice that can be made for the sake of simplicity.
+
+3. <b>Modular</b>
+
+There is no limit to the number of features and components that can be added, as long as every piece remains modular, or at most, composed out of its simpler parts. This is important to keep bundle sizes under control and also to keep the API sane. Modular components imply abstractions that do not depend on each other. This helps keep overall complexity low, so that it is simpler to extend the system.
+
+3. <b>Accessible</b>
+
+By design every component should be accessible, paying attention to keyboard navigation, focusable elements, adding helpful aria properties and following wcag specificaitons as faithfully as possible.
+
+4. <b>Dependency free</b>
+
+As few dependencies as possible, to keep things light and under control. The only dependency right now is [iconify](https://github.com/iconify/iconify) because I am not able to re-create all icons myself.
+
+---
+
+## Installation
+
+This library can be installed through npm
+
+```bash
+npm install --save simple-ui-core
+```
+
+---
+
+## How to use
+
+- The `Providers` component somewhere in the application.
+- If the application is running in nextjs, the `JSServerStyles` component has to be used in the \_document `<Head />`, this enables jss to work also server side.
+
+---

package/src/pages/navigation.mdx

@@ -0,0 +1,56 @@
+import { List } from "../List";
+import { ListButtonItem } from "../ListButtonItem";
+
+## List navigation
+
+Lists support keyboard navigation by default via the `useNavigation` hook. It can be disabled by passing the prop `navigation` and tries to emulate the [grid layout spec](https://www.w3.org/WAI/ARIA/apg/patterns/grid/examples/layout-grids/):
+
+<List ariaLabel="example" navigation={true}>
+  <ListButtonItem color="secondary" headline="Headline 1" onClick={() => {}} />
+  <ListButtonItem color="secondary" headline="Headline 2" onClick={() => {}} />
+  <ListButtonItem
+    withDivider={false}
+    color="secondary"
+    headline="Headline 3"
+    onClick={() => {}}
+  />
+</List>
+
+---
+
+<List ariaLabel="example" navigation={false}>
+  <ListButtonItem color="secondary" headline="Headline 1" onClick={() => {}} />
+  <ListButtonItem color="secondary" headline="Headline 2" onClick={() => {}} />
+  <ListButtonItem
+    withDivider={false}
+    color="secondary"
+    headline="Headline 3"
+    onClick={() => {}}
+  />
+</List>
+
+```js
+<List ariaLabel="example" navigation={true}>
+  <ListButtonItem color="secondary" headline="Headline 1" onClick={() => {}} />
+  <ListButtonItem color="secondary" headline="Headline 2" onClick={() => {}} />
+  <ListButtonItem
+    withDivider={false}
+    color="secondary"
+    headline="Headline 3"
+    onClick={() => {}}
+  />
+</List>
+
+<List ariaLabel="example" navigation={false}>
+  <ListButtonItem color="secondary" headline="Headline 1" onClick={() => {}} />
+  <ListButtonItem color="secondary" headline="Headline 2" onClick={() => {}} />
+  <ListButtonItem
+    withDivider={false}
+    color="secondary"
+    headline="Headline 3"
+    onClick={() => {}}
+  />
+</List>
+```
+
+---

package/src/pages/prism.css

@@ -0,0 +1,3 @@
+/* PrismJS 1.29.0
+https://prismjs.com/download.html#themes=prism-tomorrow&languages=markup+css+clike+javascript+jsx+tsx+typescript */
+code[class*=language-],pre[class*=language-]{color:#ccc;background:0 0;font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}

package/src/pages/useCookie.mdx

@@ -0,0 +1,15 @@
+# useCookie
+
+`useCookie` is a hook that can be used to get acceess to cookies by name, and use them as if they were React component state.
+
+```js
+const [darkModeEnabled, setDarkModeEnabled] = useCookie("dark-mode", {
+  initialValue: false,
+  // loadingValue could be different to initial value for example if we are server rendering,
+  // in which case we do not have access to cookies and you may decide to assign another
+  // value, like "pending".
+  loadingValue: false,
+});
+```
+
+---

package/src/pages/useKeyboard.mdx

@@ -0,0 +1,20 @@
+# useKeyboard
+
+This hook can be used to create keyboard shortcuts to make using a website easier and more accessible.
+
+```js
+const ref = useKeyboard([
+  {
+    key: "K",
+    metaKey: true,
+    action: (root) => root.focus(),
+  },
+  {
+    key: "Escape",
+    onlyWhenFocused: true,
+    action: () => {
+      setQuery("");
+    },
+  },
+]);
+```

package/src/pages/useNavigation.mdx

@@ -0,0 +1,30 @@
+# useNavigation
+
+The `useNavigation` hook is easy to use but complicated under the hood, so I expect there will be situations in which it will break, especially if the HTML markup is not perfectly correct. The gist of it is that it enables keyboard navigation by manipulating the `tabInde` property for all the elements under a certain element (the root). To the 'active' element we assign the `tabIndex` 0, while every other elements gets assigned `tabIndex` -1. This means that the whole area will be a single tab stop. Then, when we detect the arrow down or right we push change the active element by changing the `tabInde` and calling `element.focus()`.
+
+This is following the [grid layout pattern](https://www.w3.org/WAI/ARIA/apg/patterns/grid/examples/layout-grids/).
+
+```js
+export function List() {
+  const rootRef = useNavigation();
+
+  return (
+    <ul aria-label={ariaLabel} ref={rootRef}>
+      <li>
+        <button>Button 1</button>
+      </li>
+      <li>
+        <button>Button 2</button>
+      </li>
+      <li>
+        <button>Button 3</button>
+      </li>
+      <li>
+        <button>Button 4</button>
+      </li>
+    </ul>
+  );
+}
+```
+
+---

package/src/pages/usePromise.mdx

@@ -0,0 +1,15 @@
+# usePromise
+
+This hook can be used to unwrap a promsie value, with an initial value that can be assigned while the promise has not resolved.
+
+```js
+function Foo() {
+  const [result, error] = usePromise(Promise.resolve(10));
+
+  if (error != null) {
+    return <p>{error}</p>;
+  }
+
+  return <span>{result}</span>;
+}
+```

package/src/pages/useRefEffect.mdx

@@ -0,0 +1,49 @@
+# useRefEffect
+
+This effect is useful when you want to run an effect for a component once only (`useEffect` does not reliably do this). This implies that this component cannot have dependencies in the way other hooks do. Other hooks in this library are implemented using this.
+
+```js
+import { useRefEffect } from "./useRefEffect";
+
+export type KeyboardShortcut<T> = {
+  key: string;
+  metaKey?: boolean;
+  ctrlKey?: boolean;
+  action: (root: T) => void;
+  onlyWhenFocused?: boolean;
+};
+
+export function useKeyboard<T extends HTMLElement>(
+  shortcuts: Array<KeyboardShortcut<T>>
+) {
+  return useRefEffect<T>((root: T) => {
+    const onKeyDown = (e: KeyboardEvent) => {
+      for (const {
+        metaKey,
+        key,
+        action,
+        ctrlKey,
+        onlyWhenFocused,
+      } of shortcuts) {
+        if (metaKey && e.metaKey !== true) {
+          continue;
+        } else if (ctrlKey && e.ctrlKey !== true) {
+          continue;
+        } else if (onlyWhenFocused && document.activeElement !== root) {
+          continue;
+        }
+
+        if (e.key.toLowerCase() === key.toLowerCase()) {
+          action(root);
+        }
+      }
+    };
+
+    window.addEventListener("keydown", onKeyDown);
+
+    return () => {
+      window.removeEventListener("keydown", onKeyDown);
+    };
+  });
+}
+```

package/src/stateMachineContextFactory.tsx

@@ -0,0 +1,111 @@
+import React, {
+  useContext,
+  useCallback,
+  ReactNode,
+  useMemo,
+  useRef,
+} from "react";
+import { Subscribe, createEmitter, Callback } from "./Emitter";
+
+export type Reducer<State, Context> = <Data extends any>({
+  state,
+  context,
+  data,
+}: {
+  state: State;
+  context: Context;
+  data: Data;
+}) => { state: State; context: Context };
+
+type StateMachineConfig<State, Transition, Context> = {
+  states: {
+    [state: string]: {
+      // @ts-ignore
+      on: { [transition: Transition]: Reducer<State, Context> };
+    };
+  };
+  context: Context;
+  state: State;
+};
+
+type Send = <Transition, Data>(transition: Transition, data: Data) => void;
+
+type StateMachineContextType<State, Context> = {
+  subscribe: Subscribe<{ state: State; context: Context }>;
+  send: Send;
+};
+
+export function stateMachineContextFactory<State, Transition, Context>(
+  stateMachineConfig: StateMachineConfig<State, Transition, Context>
+) {
+  const StateMachineContext = React.createContext<
+    StateMachineContextType<State, Context>
+  >({
+    subscribe: () => {
+      throw new Error("Not implemented");
+    },
+    send: (_) => {
+      throw new Error("Not implemented");
+    },
+  });
+
+  type StateMachineState = {
+    state: State;
+    context: Context;
+  };
+
+  function Provider({ children }: { children: ReactNode }) {
+    const stateMachineRef = useRef<StateMachineState>({
+      state: stateMachineConfig.state,
+      context: stateMachineConfig.context,
+    });
+
+    const emitterRef = useRef(
+      createEmitter<{ state: State; context: Context }>()
+    );
+
+    const subscribe = useCallback((callback: Callback<StateMachineState>) => {
+      const unsbuscribe = emitterRef.current.subscribe(callback);
+      callback(stateMachineRef.current);
+
+      return unsbuscribe;
+    }, []);
+
+    const send = useCallback(
+      <Transition, Data extends any>(transition: Transition, data: Data) => {
+        const state = stateMachineRef.current.state;
+        // @ts-ignore I don't know how to fix this
+        const transitions = stateMachineConfig.states[state].on;
+        const reducer: Reducer<State, Context> = transitions[transition];
+
+        if (!reducer) {
+          // No transition available in the current state, so no update needed
+          return;
+        }
+
+        const newState = reducer({
+          ...stateMachineRef.current,
+          data,
+        });
+
+        stateMachineRef.current = newState;
+        emitterRef.current.emit(newState);
+      },
+      []
+    );
+
+    const value = useMemo(() => ({ subscribe, send }), [subscribe, send]);
+
+    return (
+      <StateMachineContext.Provider value={value}>
+        {children}
+      </StateMachineContext.Provider>
+    );
+  }
+
+  function useStateMachine() {
+    return useContext(StateMachineContext);
+  }
+
+  return { Provider, useStateMachine };
+}

package/src/useCookie.tsx

@@ -0,0 +1,89 @@
+import { useState, useCallback, useEffect, useRef } from "react";
+
+export function hasCookie(key: string): boolean {
+  return (
+    document.cookie
+      .split(";")
+      .map((c) => c.trim())
+      .filter((c) => c.startsWith(`${key}=`)).length > 0
+  );
+}
+
+export function getCookie<T>(
+  key: string,
+  deserialize: (s: string) => T = JSON.parse
+): T {
+  return document.cookie
+    .split(";")
+    .map((c) => c.trim())
+    .filter((c) => c.startsWith(`${key}=`))
+    .map((s) => s.split("=")[1])
+    .map((s) => deserialize(s))
+    .pop();
+}
+
+export function useCookie<T, L>(
+  key: string,
+  {
+    initialValue = null,
+    loadingValue,
+    serialize = JSON.stringify,
+    deserialize = JSON.parse,
+    maxAge = 60 * 60 * 24 * 365,
+  }: {
+    initialValue: T;
+    loadingValue: L;
+    serialize?: (t: T) => string;
+    deserialize?: (s: string) => T;
+    maxAge?: number;
+  }
+): [T | L, (t: T | ((prevValue: T | L) => T)) => void] {
+  const initializationRef = useRef(false);
+  const [cookie, setCookie] = useState<T | L>(() => {
+    if (typeof window !== "undefined") {
+      const hasPersistedCookie = hasCookie(key);
+      if (hasPersistedCookie) {
+        return getCookie(key, deserialize);
+      } else {
+        return loadingValue;
+      }
+    }
+
+    return loadingValue;
+  });
+
+  useEffect(() => {
+    if (initializationRef.current === true) {
+      return;
+    }
+
+    const hasPersistedCookie = hasCookie(key);
+
+    if (hasPersistedCookie) {
+      const persistedCookie = getCookie(key, deserialize);
+      setCookie(persistedCookie);
+    } else {
+      document.cookie = `${key}=${serialize(initialValue)}; max-age=${maxAge};`;
+      setCookie(initialValue);
+    }
+    initializationRef.current = true;
+  }, []);
+
+  return [
+    cookie,
+    useCallback((t: T | ((prevValue: T | L) => T)) => {
+      if (typeof t === "function") {
+        // @ts-ignore
+        const callback: (prevValue: T | L) => T = t;
+        setCookie((oldCookie) => {
+          const newValue = callback(oldCookie);
+          document.cookie = `${key}=${serialize(newValue)}; max-age=${maxAge};`;
+          return newValue;
+        });
+      } else {
+        setCookie(t);
+        document.cookie = `${key}=${serialize(t)}; max-age=${maxAge};`;
+      }
+    }, []),
+  ];
+}

package/src/useKeyboard.tsx

@@ -0,0 +1,43 @@
+import { useRefEffect } from "./useRefEffect";
+
+export type KeyboardShortcut<T> = {
+  key: string;
+  metaKey?: boolean;
+  ctrlKey?: boolean;
+  action: (root: T) => void;
+  onlyWhenFocused?: boolean;
+};
+
+export function useKeyboard<T extends HTMLElement>(
+  shortcuts: Array<KeyboardShortcut<T>>
+) {
+  return useRefEffect<T>((root: T) => {
+    const onKeyDown = (e: KeyboardEvent) => {
+      for (const {
+        metaKey,
+        key,
+        action,
+        ctrlKey,
+        onlyWhenFocused,
+      } of shortcuts) {
+        if (metaKey && e.metaKey !== true) {
+          continue;
+        } else if (ctrlKey && e.ctrlKey !== true) {
+          continue;
+        } else if (onlyWhenFocused && document.activeElement !== root) {
+          continue;
+        }
+
+        if (e.key.toLowerCase() === key.toLowerCase()) {
+          action(root);
+        }
+      }
+    };
+
+    window.addEventListener("keydown", onKeyDown);
+
+    return () => {
+      window.removeEventListener("keydown", onKeyDown);
+    };
+  });
+}

package/src/useNavigation.tsx

@@ -0,0 +1,89 @@
+import { useRef, useCallback, useEffect } from "react";
+
+import { queryFocusables, focusElement, normalizeElements } from "./aria";
+import { useRefEffect } from "./useRefEffect";
+
+export function useNavigation({
+  autofocus = false,
+  rowLength = 1,
+  enabled = true,
+} = {}) {
+  return useRefEffect((root: HTMLElement) => {
+    if (!enabled) {
+      return;
+    }
+
+    let index = 0;
+
+    const elements = queryFocusables(root);
+
+    if (elements.length === 0) {
+      return;
+    }
+
+    if (elements.length !== 0 && autofocus) {
+      focusElement(elements, index);
+    } else {
+      normalizeElements(elements, index);
+    }
+
+    const onKeyDown = (e: KeyboardEvent) => {
+      const elements = queryFocusables(root);
+
+      if (elements.length === 0) {
+        return;
+      }
+
+      let newIndex: number = -1;
+
+      if (e.code === "ArrowUp") {
+        if (index - rowLength < 0) {
+          newIndex = elements.length - (elements.length % rowLength) + index;
+        } else {
+          newIndex = index - rowLength;
+        }
+      } else if (e.code === "ArrowLeft") {
+        if (index <= 0) {
+          newIndex = elements.length - 1;
+        } else {
+          newIndex = index - 1;
+        }
+      } else if (e.code === "ArrowRight") {
+        if (index >= elements.length - 1) {
+          newIndex = 0;
+        } else {
+          newIndex = index + 1;
+        }
+      } else if (e.code === "ArrowDown") {
+        if (index + rowLength > elements.length - 1) {
+          newIndex = (index + rowLength) % rowLength;
+        } else {
+          newIndex = index + rowLength;
+        }
+      }
+
+      if (newIndex !== -1 && index !== newIndex) {
+        index = newIndex;
+        focusElement(elements, index);
+        e.preventDefault();
+        e.stopPropagation();
+      }
+    };
+
+    root.addEventListener("keydown", onKeyDown);
+
+    const observer = new MutationObserver((mutationList) => {
+      if (mutationList.filter((m) => m.type === "childList").length > 0) {
+        const elements = queryFocusables(root);
+        if (elements.length > 0) {
+          normalizeElements(elements, index);
+        }
+      }
+    });
+    observer.observe(root, { childList: true });
+
+    return () => {
+      root.removeEventListener("keydown", onKeyDown);
+    };
+  });
+}

package/src/usePromise.tsx

@@ -0,0 +1,18 @@
+import { useState, useEffect } from "react";
+
+export function usePromise<T>(
+  promiseFactory: () => Promise<T>,
+  inputs: Array<any>,
+  initialValue: T
+): [T | null, any] {
+  const [value, setValue] = useState(initialValue);
+  const [error, setError] = useState(null);
+
+  useEffect(() => {
+    promiseFactory()
+      .then((value) => setValue(value))
+      .catch((error) => setError(error));
+  }, inputs);
+
+  return [value, error];
+}

package/src/useRefEffect.tsx

@@ -0,0 +1,18 @@
+import { useRef, useCallback } from "react";
+
+export function useRefEffect<T>(
+  callback: (root: T) => (() => void) | void
+): (root: T) => void {
+  const unsubscribeRef = useRef<(() => void) | void>(null);
+
+  const refCallback = useCallback((root: T | null) => {
+    if (root === null) {
+      unsubscribeRef.current && unsubscribeRef.current();
+    } else {
+      const unsubscribe = callback(root);
+      unsubscribeRef.current = unsubscribe;
+    }
+  }, []);
+
+  return refCallback;
+}

package/tsconfig.build.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "es2020", "es2020.string"],
+    "target": "ES2020",
+    "module": "esnext",
+    "sourceMap": true,
+    "outDir": "dist/",
+    "jsx": "react-jsx",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "declaration": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": false,
+    "incremental": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true
+  },
+  "include": ["src/*"],
+  "exclude": ["node_modules"]
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "es2020", "es2020.string"],
+    "target": "ES2020",
+    "module": "esnext",
+    "sourceMap": true,
+    "outDir": "dist/",
+    "jsx": "preserve",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "declaration": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": false,
+    "incremental": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true
+  },
+  "include": ["src/*"],
+  "exclude": ["node_modules"]
+}