My Design System

Why I Created a Design System

I was using Material UI for a project, and the bundle size, combined with the css-in-js approach to styling, resulted in an application that was difficult to render on the server and that had a pretty poor initial load time. I wanted to create a design system that was similar to Material UI / Flutter but that emphasized semantic HTML and a small bundle size.

Also, when creating a Rich Text Editor with Lexical, I found that it was best to not use highly abstracted components, so I tried to create a library of simple components that can be easily rendered on the server and that doesn't use too much CSS and JavaScript.

In summary, the goal of the design system is to create a look that is comparable to other popular design libraries used today while minimizing load time, bundle size, and complexity.

Assumptions

NOTE: This design system uses CSS and JavaScript that are tied together - i.e., some classes are required for components' JavaScript to work correctly. The design system bundles and transpiles client-side JavaScript using webpack, which is why you might want to download the JavaScript and CSS files from the resources section and tweak them / re-transpile them for your own use. If you make changes to the CSS, I recommend you use PostCSS so your changes will appear the same across all browsers.

The design system assumes that:

you want to use HTMX to create a SPA (Single Page Application),
you want to use semantic html, but that you want to style components primarily with CSS classes and inline styling,
your Content Security Policy allows for inline styling,
you want to use Floating UI for tooltips, menus, dropdowns, and the like,
you want to have slightly different layouts for desktop and mobile,
you want to prioritize mobile devices (you want the application that you show the user to always be similar to the mobile device view),
you do not want to listen to resize events on mobile

Explore the Design System

If you are looking for information about specific components or utility classes, use the links in the list below to find more information about those aspects of the system. Each aspect of the design system should describe the styling, accessability, and JavaScript concerns that go along with it.

If you are looking to learn more about the design system and the decisions made, continue reading below or navigate to the 'General' page for the design system.

If you want the code, navigate to the resources section.

Note that I am still working on documenting the design system. I got tired of writing the documentation and wanted to move onto other things. I will come back and finish / improve the documentation eventually.

Components and Utility Classes

NOTE: Popovers includes tooltips, dropdowns, dialogs, and menus - basically everything that is shown on mouseover or focus or everything that is in the top-layer. Media includes images, video, and audio. Surfaces includes cards, quotes, and asides. Other Inputs includes toggle buttons. Tabs includes tabs, steppers, and mobile steppers. Fixed Content includes the navbar, footer, sidebars, drawers, and Floating Action Buttons.

Math

About Math Markdown

I use

KaTeX

to render math markup for this website. The only

KaTeX

-related things included in the design system are a couple of css classes for the wrapper of the <math> elements (minimal size). If you want to include

KaTeX

in your project, check out the KaTex documentation.
I do not know

TeX

that well, and I didn't how how well

KaTeX

would render mathematical expressions, so I tested some

KaTeX

expressions below to see what would work.

Note that you can display the $TeX$ expression as either a block or an inline element. The block element will always have a white background.

To generate Math markup, click the button below, click the Math Markup button on the navigation sidebar, or press CTRL+M.

Math Examples

$KaTeX$ Input and Output
Input	Block	Inline
TeX	$TeX$	$TeX$
KaTeX	$KaTeX$	$KaTeX$
LaTeX	$LaTeX$	$LaTeX$
a^2+b^2=c^2	$a^2+b^2=c^2$	$a^2+b^2=c^2$
a^{23}+b^{225}=c^{56}	$a^{23}+b^{225}=c^{56}$	$a^{23}+b^{225}=c^{56}$
3x^{4x^{2y}+5}	$3x^{4x^{2y}+5}$	$3x^{4x^{2y}+5}$
\pi\ \Pi	$\pi\ \Pi$	$\pi\ \Pi$
\begin{align} y=\log x \\ y = \log_5 x \\ y = \ln x \end{align}	$\begin{align} y=\log x \\ y = \log_5 x \\ y = \ln x \end{align}$	\align can only be used in display mode.
\frac{2}{3}	$\frac{2}{3}$	$\frac{2}{3}$
\dfrac{5}{6}	$\dfrac{5}{6}$	$\dfrac{5}{6}$
\frac{\sqrt{x+1}}{\sqrt{x+2}}	$\frac{\sqrt{x+1}}{\sqrt{x+2}}$	$\frac{\sqrt{x+1}}{\sqrt{x+2}}$
2\left(\frac{1}{x^2-1}\right)	$2\left(\frac{1}{x^2-1}\right)$	$2\left(\frac{1}{x^2-1}\right)$
2\left[\frac{1}{x^2-1}\right]	$2\left[\frac{1}{x^2-1}\right]$	$2\left[\frac{1}{x^2-1}\right]$
2\left\{\frac{1}{x^2-1}\right\}	$2\left\{\frac{1}{x^2-1}\right\}$	$2\left\{\frac{1}{x^2-1}\right\}$
2\left\langle \frac{1}{x^2-1}\right\rangle	$2\left\langle \frac{1}{x^2-1}\right\rangle$	$2\left\langle \frac{1}{x^2-1}\right\rangle$
\left(\frac{1}{1+ \left(\frac{1}{1+x}\right)}\right)	$\left(\frac{1}{1+ \left(\frac{1}{1+x}\right)}\right)$	$\left(\frac{1}{1+ \left(\frac{1}{1+x}\right)}\right)$
Ldots = a_0,a_1,a_2,\ldots, a_{100}	$Ldots = a_0,a_1,a_2,\ldots, a_{100}$	$Ldots = a_0,a_1,a_2,\ldots, a_{100}$
Cdots = a_0,a_1,a_2,\cdots, a_{100}	$Cdots = a_0,a_1,a_2,\cdots, a_{100}$	$Cdots = a_0,a_1,a_2,\cdots, a_{100}$
y=\csc \theta	$y=\csc \theta$	$y=\csc \theta$
y=\arcsin x	$y=\arcsin x$	$y=\arcsin x$
a(b+c)=ab+ac for all for all a, b, x, \in \mathbb{R}.	$a(b+c)=ab+ac for all for all a, b, x, \in \mathbb{R}.$	$a(b+c)=ab+ac for all for all a, b, x, \in \mathbb{R}.$
\begin{tabular}{\|c\|\|c\|c\|c\|c\|c\|} \hline $x$ & 1 & 2 & 3 & 4 & 5 \\ \hline $f(x)$ & 10 & 11 & 12 & 13 & 14 \\ \hline \end{tabular}	No such environment: tabular	No such environment: tabular
\begin{align} 5x^2-9&=x+3\\ 5x^2-x-12&=0\\ \end{align}	$\begin{align} 5x^2-9&=x+3\\ 5x^2-x-12&=0\\ \end{align}$	{align} can be used only in display mode.
\begin{enumerate} \item Hot Dog \item Mustard \item Buns \item Relish \end{enumerate}	No such environment: enumerate	No such environment: enumerate
\textbf{bold}\ text	$\textbf{bold}\ text$	$\textbf{bold}\ text$
Please\ excuse\ my\ \begin{large}dear\ aunt\ Sally\end{large}. \\ Please\ excuse\ my\ \begin{Large}dear\ aunt\ Sally\end{Large}. \\ Please\ excuse\ my\ \begin{huge}dear\ aunt\ Sally\end{huge}.	No such environment: large	No such environment: large
Conclusions: I had a hard time figuring out how to properly use KaTeX based on the documentation alone. Granted, I have only taken a course on LaTeX that lasted a few hours, but I felt like that should have given me the information I needed to be able to properly parse the docs and use LaTeX. I wasn't able to really figure out how KaTeX works based on the docs alone, so I created this table to try to see what works and what doesn't. KaTeX seems to work fine to represent equations without the need to escape equations on the client or server, and I planned on using this just to render equations and maybe groups of equations, so the system I am using now seems to work fine for me. NOTE: If you want to include spaces, make sure to include "\ ".

Search Icons

About Icon Search

Resources

Click on the individual buttons to download separate files, or click on the All Files button to download a ZIP file of all the code. The code is sent pre-transpiled for readability.
Click on the VSCode Snippet button to download a copy of the html.json file that will make implementing this design system simpler.

All Files

Shared CSS

Desktop CSS Mobile CSS

Shared JavaScript

Desktop JavaScript Mobile JavaScript

VSCode Snippet