Skip to content

Latest commit

 

History

History
183 lines (135 loc) · 6.37 KB

README.md

File metadata and controls

183 lines (135 loc) · 6.37 KB

Soda.css

Soda.css - "Go fizz™"

About

Soda.css is a small CSS project that offers clean default styling templates and a simple color palette.

If your project requires more complicated features, such as dynamic interactions or component stylings, perhaps you can try out other libraries, for example, Bootstrap or Tailwind CSS.

The project is open source and is protected under the MIT license. See license in Soda.css/LICENSE.

All changes can be found in Soda.css/CHANGELOG.

Let me know if you have any questions or requests on Discord: @therock2t.

Download

Option 1: Compile from source

Open a terminal and run the following commands:

git clone https://github.com/DmmDGM/soda.css
cd soda.css
npm install -g sass@latest
sass --no-source-map --style=compressed src:out

Option 2: Download from releases

Visit https://github.com/DmmDGM/soda.css/releases and install the latest version.

Documentation and Guides

Adding Alpha Values to Soda.css Colors

It is possible to apply an alpha channel to any pre-defined hex color by using the relative rgb syntax:

rgb(from [color] r g b / [alpha])
button {
	background-color: rgb(from var(--sd-red) r g b / 0.5);
	border-radius: 5px;
	cursor: pointer;
	padding: 5px 10px;
	transition: background 0.2s ease;
}

button:focus-visible, button:hover {
	background-color: var(--sd-red);
}

Warning

Requires the use of relative CSS, which might not be supported on older browsers. Check browser compatibility for more information.

Applying Different Shades of Soda.css Colors

Soda.css offers a wide variety of colors and shades. All colors begin with the prefix --sd:

a {
	color: var(--sd-blue);
}

button {
	background-color: var(--sd-red);
}

Use the *-l[number] and *-d[number] suffix to make the color lighter or darker:

a {
	color: var(--sd-blue);
	transition: color 0.2s ease;
}

a:focus-visible, a:hover {
	color: var(--sd-blue-d20);
}

button {
	background-color: var(--sd-red);
	cursor: pointer;
	transition: background 0.2s ease;
}

button:focus-visible, button:hover {
	background-color: var(--sd-red-l10);
}

Note

Some colors have different limits to how light or dark they can be. For example, red has an upper limit of *-l15 and a lower limit of *-d50, while gray has an upper limit of *-l10 and a lower limit of *-d15. See Full List of Soda.css Colors for more information.

Additionally, all colors have a light-* and a dark-* alias, which correspond to the -l10 and -d20 shades respectively.

/* ... */

a:focus-visible, a:hover {
	/* color: var(--sd-blue-d20); */
	color: var(--sd-dark-blue);
}

/* ... */

button:focus-visible, button:hover {
	/* background-color: var(--sd-red-l10); */
	background-color: var(--sd-light-red);
}

Disabling Certain Features in Soda.css

Soda.css does not use a module-based system. Therefore, there are no official way to disable certain features in Soda.css. However, you can disable them manually by deleting the corresponding code or overwriting them in the compiled code.

Alternatively, if you only use Soda.css for the custom colors, you can try out Sodalite.css.

Disabling Soda.css's Default Styling (Before v1.1.0)

By default, Soda.css will automatically style the entire document to provide a clean starting template for your project. If this is an unwanted behavior, use the following CSS after the initialization of Soda.css to revert the changes:

* {
	background: initial;
	border: initial;
	color: initial;
	font: initial;
	height: initial;
	margin: initial;
	outline: initial;
	padding: initial;
	scrollbar-color: initial;
	scrollbar-width: initial;
	text-decoration: initial;
	width: initial;
}

Alternatively, you can simply delete the relevant styles in your compiled Soda.css.

Note

For Soda.css v1.1.0 and above, you can use the Sodalite.css option.

Full List of Soda.css Colors

Below is the full list of available Soda.css colors:

Color Name Base Color Hex CSS Variable Brightness Range
Color Red #ef4f4f --sd-red d50 - l15
Color Orange #ef8f4f --sd-orange d50 - l15
Color Yellow #efef4f --sd-yellow d50 - l15
Color Green #4fef4f --sd-green d50 - l15
Color Cyan #4fefef --sd-cyan d50 - l15
Color Sky #4fbfef --sd-sky d50 - l15
Color Blue #4f4fef --sd-blue d50 - l15
Color Purple #8f4f8f --sd-purple d35 - l15
Color Magenta #ef0fbf --sd-magenta d35 - l15
Color Pink #ef8fbf --sd-pink d50 - l15
Color White #efefef --sd-white d15 - l10
Color Gray #8f8f8f --sd-gray d15 - l10
Color Black #1f1f1f --sd-black d15 - l10
Color Sand #efbf8f --sd-sand d50 - l15
Color Peach #efbf4f --sd-peach d50 - l15
Color Mint Green #bfef8f --sd-mint-green d50 - l15
Color Forest #0f8f4f --sd-forest d25 - l15
Color Mint Blue #8fefef --sd-mint-blue d50 - l15
Color Cherry Blossom #efbfbf --sd-cherry-blossom d50 - l15

Note

All colors have a light-* and a dark-* alias, which correspond to the *-l10 and *-d20 shades respectively.

Last Updated: August 14th, 2024