Alternative Checkboxes Reference Set

# ✅ Alternative Checkboxes Reference Set

<a href="https://github.com/damiankorczAlternative-Checkboxes-Reference-Set/releases"><img src="https://img.shields.io/github/v/release/damiankorcz/Alternative-Checkboxes-Reference-Set?style=for-the-badge&color=%23A47B61&labelColor=%23252525&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABmJLR0QA/wD/AP+gvaeTAAAA1klEQVRIiWNgoDFgXJjpXU5LC1gYGP930NYCBgYGfV1NBn1dTaoafPHydYaLl68zMFHVVCyA5hawMDAgvEMbCxj/dzIwMNgw/Ge0FhMVpoqhr16/ZWBg/H+UgYHhCCMDAwPDwiyvBgYGhvq4qCCqWLBo2ToGBgaGxvhp2xroEwf4wKvXbxhevX6HVU5MTJhBTAR/sBK04P6DJww3b9/DKqeupkS5BeamBgzmpgaElOEEQz+jjVowagHlACWjQQsp6lvwj4npANO/f1Q1+B8T0wGqGogLAADmITOhp5zsqQAAAABJRU5ErkJggg==" /></a>
<a href="https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/stargazers"><img src="https://img.shields.io/github/stars/damiankorcz/Alternative-Checkboxes-Reference-Set?color=8a7840&style=for-the-badge&labelColor=%23252525&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABmJLR0QA/wD/AP+gvaeTAAABvUlEQVRIieWTwUsUYRjGf8+3EoRdlG52SHDbzU0o2tkNwbP/gHjtpqJBRR0iiAo6GgglgdDBc/0Xhelut4pmdoMU6iJCl6BD7rwdbGq3ZrZvpEv0wsDwfc/z/J6PmQ/+q7FGedK2xqfyeAZyMu7gYgOmfQ3yFdrm6Qs4ewGAi6dUbT338TlfAM5u/3iPCzd9bV4nsM3yeRzNHr3iuoJW44+9vGoUuPtbGXO3fKyZJ7CXp47TcUVkAWglRWtgVzA1KcRtVVt7mQDbKo2CLiKKQBExhjHk07Ar6RPGO6CN0QZbVz16fwAwRLP0ELSYKzQTZo+pRnMSsQOQMILoEuLBX4hfS8Kh6yNLGNXwMtjK4bP1iCBcSMJ7AAlEtegq6N4h0pdVe7soYT2ZWWprlJeBa57h91ULr6dt9LkH9sYzHOB11kYfgCo5AJnafjf5TA5ApjYv4NX359eZyAWwZxNDwMjPBXYQ82yH5wjCs5jNAu0uy4htVIa9ARzpJO13Md1geL+kIFzTLB2JWPXoCW6wgpgHPh54vo6nRaX+ptYszWA6yf7nVU1++JJaItFunDjKwLElZNsKoqf9tP/mfANgQ4DZEhtxewAAAABJRU5ErkJggg==" /></a>
<a href="https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/blob/main/LICENSE"><img src="https://img.shields.io/github/license/damiankorcz/Alternative-Checkboxes-Reference-Set?color=%23048c09&style=for-the-badge&labelColor=%23252525&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAAV0lEQVQ4jWNkYGBgqOie85+BDNBRmsLIAuO0lySTpLmyZy4DAwMDAxM5NiMDig1gQReo7JnL0F6SDHciOkD3KoYBMAXEhsmoCwaDCwY+JVIvKeMKNEIAAB9dK8YXTwb/AAAAAElFTkSuQmCC" /></a>
<br />

## 🎯 Objective

This is an initiative to help standardize the Alternative Checkboxes feature commonly used by the community in Obsidian.md.

The result is a Reference Set CSS and supporting Usage Guide which is there to serve as a foundation for customisation, creating other Alternative Checkbox sets and encouraging theme developers to implement toggle options for their built in Alternative Checkboxes. This allows users to use their own snippets without hacky overwrites.

We achieved this by analyzing all publicly available implementations of Alternative Checkboxes within Obsidian be it as a Theme, CSS Snippet or Plugin and creating an easy to customise snippet.

You can review the research that went into this by downloading the [Research Vault from the Releases section](https://github.com/damiankorczAlternative-Checkboxes-Reference-Set/releases) and opening the folder in Obsidian.

| Light / Dark Theme |
| -------------------|
| ![Light / Dark Theme Reference Set Alternative Checkboxes](https://github.com/user-attachments/assets/b749cb4e-2d9e-4600-b2c8-004de9ca49bd) |


## 🗃️ Usage

Please refer to the [Usage Guide](https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/blob/main/Usage%20Guide.md) for information on how to use the Reference Set snippet, implement toggles in your theme for your current Alternative Checkboxes implementation, as well as, how to make your own set based on the reference.

## 🗣️ Discussion

Previously, all discussion regarding this initiative was carried out in a thread within the Official Obsidian Discord. To see the archive visit here:
https://discord.com/channels/686053708261228577/1291469509336502272

Current thread for discussion:
https://discord.com/channels/686053708261228577/1382776035195490353

Please use the [Issues](https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/issues) section in this repository to report any issues, ask for help with implementing toggles in your theme or creating your own Alternative Checkbox sets, etc.

## 🛠 Contributing

At the moment, there are no direct guidelines for contributing to this repository. Ideally, any contributions should be discussed in an Issue first.

## 📣 Acknowledgments

Special thanks to the following people for their direct contributions to this repository:
- [**claremacrae** ](https://github.com/claremacrae) - For assisting in parsing through all available themes in Obsidian's Community Themes Store.
- [**ElsaTam**](https://github.com/ElsaTam) - For reviewing the CSS in each theme to identify the patterns used to implement the feature.
- [**sigrunixia**](https://github.com/sigrunixia) - For helping with the Repository maintenance and outward tasks like presenting the initiative to new themes.

Also, big thanks to everyone that contributed feedback over in the Discord Thread.

## 📝 Licenses

The Research Vault contains Themes, CSS Snippets and Plugins which were added for convenience of previewing the relevant documentation. Here are the licenses which they are distributed under:

<details>
<summary>Themes</summary>

- [Minimal](https://github.com/kepano/obsidian-minimal) - Distributed under the [MIT License](https://github.com/kepano/obsidian-minimal/blob/master/LICENSE)
- [Things](https://github.com/colineckert/obsidian-things) - Distributed under the [MIT License](https://github.com/colineckert/obsidian-things/blob/main/LICENSE)
- [Blue Topaz](https://github.com/PKM-er/Blue-Topaz_Obsidian-css) - Distributed under the [MIT License](https://github.com/PKM-er/Blue-Topaz_Obsidian-css/blob/master/LICENSE)
- [AnuPpuccin](https://github.com/AnubisNekhet/AnuPpuccin) - Distributed under the [GPL-3.0 License](https://github.com/AnubisNekhet/AnuPpuccin/blob/main/LICENSE)
- [Sanctum](https://github.com/jdanielmourao/obsidian-sanctum) - Distributed under the [MIT License](https://github.com/jdanielmourao/obsidian-sanctum/blob/main/LICENSE)
- [ITS](https://github.com/SlRvb/Obsidian--ITS-Theme) - Distributed under the [GPL-2.0 License](https://github.com/SlRvb/Obsidian--ITS-Theme/blob/main/LICENSE)
- [Primary](https://github.com/primary-theme/obsidian) Distributed under the [GPL-3.0 License](https://github.com/primary-theme/obsidian/blob/main/LICENSE)
- [Tokyo Night](https://github.com/tcmmichaelb139/obsidian-tokyonight) - Distributed under the [MIT License](https://github.com/tcmmichaelb139/obsidian-tokyonight/blob/main/LICENSE)
- [Border](https://github.com/Akifyss/obsidian-border) - Distributed under the [MIT License](https://github.com/Akifyss/obsidian-border/blob/main/LICENSE)
- [Spectrum](https://github.com/wiktoriavh/Spectrum) - Distributed under the [MIT License](https://github.com/wiktoriavh/Spectrum/blob/main/LICENSE)
- [Cyber Glow](https://github.com/ArtexJay/Obsidian-CyberGlow) - Distributed under the [MIT License](https://github.com/ArtexJay/Obsidian-CyberGlow/blob/main/LICENSE)
- [LYT Mode](https://github.com/nickmilo/LYT-Mode) - Distributed under the [MIT License](https://github.com/nickmilo/LYT-Mode/blob/main/LICENSE)
- [Shiba Inu](https://github.com/faroukx/Obsidian-shiba-inu-theme) - Distributed under the [MIT License](https://github.com/faroukx/Obsidian-shiba-inu-theme/blob/main/LICENSE.txt) 
- [PLN](https://github.com/PipeItToDevNull/PLN) - Distributed under the [GPL-3.0 License](https://github.com/PipeItToDevNull/PLN/blob/master/LICENSE.md)
- [Obsidianotion](https://github.com/diegoeis/obsidianotion) - Distributed under the [Unlicense License](https://github.com/diegoeis/obsidianotion/blob/master/LICENSE)
- [Maple](https://github.com/subframe7536/obsidian-theme-maple) - Distributed under the [MIT License](https://github.com/subframe7536/obsidian-theme-maple/blob/main/LICENSE)
- [Ebullientworks](https://github.com/ebullient/obsidian-theme-ebullientworks) - Distributed under the [CC0-1.0 License](https://github.com/ebullient/obsidian-theme-ebullientworks/blob/main/LICENSE)
- [Pine Forest Berry](https://github.com/Nilahn/pine_forest_berry/) - Distributed under the [MIT License](https://github.com/Nilahn/pine_forest_berry/blob/main/LICENSE)
- [Aura](https://github.com/ashwinjadhav818/obsidian-aura) - Distributed under the [GPL-2.0 License](https://github.com/ashwinjadhav818/obsidian-aura/blob/master/LICENSE)
- [Vicious](https://github.com/zaheralmajed/vicious-theme-obsidian) - Distributed under the [MIT License](https://github.com/zaheralmajed/vicious-theme-obsidian/blob/main/LICENSE)
- [Simple](https://github.com/diegoeis/simple-obsidian) - Distributed under the [Unlicense License](https://github.com/diegoeis/simple-obsidian/blob/main/LICENSE)
- [Elegance](https://github.com/Victologo/elegance-theme) - Distributed under the [MIT License](https://github.com/Victologo/elegance-theme/blob/main/LICENSE)
- [Material Ocean](https://github.com/dragonwocky/obsidian-material-ocean) - Distributed under the [MIT License](https://github.com/dragonwocky/obsidian-material-ocean/blob/main/LICENSE)
- [Sparkling Night](https://github.com/isax785/obsidian-sparkling-night) - Distributed under the [MIT License](https://github.com/isax785/obsidian-sparkling-night/blob/master/LICENSE)
- [Kakano](https://github.com/isaacfreeman/kakano-obsidian-theme) - Distributed under the [MIT License](https://github.com/isaacfreeman/kakano-obsidian-theme) 
- [Neo](https://github.com/lab-do/obsidian-neo) - Distributed under the [MIT License](https://github.com/lab-do/obsidian-neo/blob/main/LICENCE)
- [Feather](https://github.com/zfmohammed/obsidian-feather) - Distributed under the [MIT License](https://github.com/zfmohammed/obsidian-feather/blob/main/LICENSE)
- [Listive](https://github.com/efemkay/obsidian-listive-theme) - Distributed under the [MIT License](https://github.com/efemkay/obsidian-listive-theme/blob/master/LICENSE.md)
- [MagicUser](https://github.com/drbap/magicuser-theme-for-obsidian) - Distributed under the [MIT License](https://github.com/drbap/magicuser-theme-for-obsidian/blob/main/LICENSE)
- [Qlean](https://github.com/Fro-Q/Qlean) - Distributed under the [MIT License](https://github.com/Fro-Q/Qlean/blob/main/LICENSE)
- [Yue](https://github.com/GixoXYZ/YueObsidian) - Distributed under the [MIT License](https://github.com/GixoXYZ/YueObsidian/blob/main/LICENSE)
- [sQdthOne](https://github.com/KeithLerner/ObsidianMDsQdthOne) - Distributed under the [GPL-3.0 License](https://github.com/KeithLerner/ObsidianMDsQdthOne/blob/main/LICENSE)
- [Dracula Plus](https://github.com/saket61195/Dracula_obsidian_theme) - Distributed under the [MIT License](https://github.com/saket61195/Dracula_obsidian_theme/blob/main/LICENSE)
- [Solitude](https://github.com/KyleKlus/solitude-obsidian-theme) - Distributed under the [MIT License](https://github.com/KyleKlus/solitude-obsidian-theme/blob/main/LICENCE)
- [Prime](https://github.com/rivea0/obsidian-prime) - Distributed under the [GPL-3.0 License](https://github.com/rivea0/obsidian-prime/blob/main/LICENSE)
- [Sanctum Reborn](https://github.com/antoKeinanen/obsidian-sanctum-reborn) - Distributed under the [MIT License](https://github.com/antoKeinanen/obsidian-sanctum-reborn/blob/main/LICENSE)
- [Underwater](https://github.com/Seniblue/Underwater) - Distributed under the [MIT License](https://github.com/Seniblue/Underwater/blob/main/LICENSE)
- [Nightingale](https://github.com/frank0713/nightingale-obsidian) - Distributed under the [MIT License](https://github.com/frank0713/nightingale-obsidian/blob/main/LICENSE)
- [Reshi](https://github.com/contrapasso3/Reshi) - Distributed under the [GPL-3.0 License](https://github.com/contrapasso3/Reshi/blob/main/LICENSE)
- [Shade Sanctuary](https://github.com/Elevict/Shade-Sanctuary) - Distributed under the [MIT License](https://github.com/Elevict/Shade-Sanctuary/blob/main/LICENSE)
- [Sparkling Day](https://github.com/isax785/obsidian-sparkling-day) - Distributed under the [MIT License](https://github.com/isax785/obsidian-sparkling-day/blob/master/LICENSE)
- [Oreo](https://github.com/carols12352/Oreo-theme) - Distributed under the [GPL-3.0 License](https://github.com/carols12352/Oreo-theme/blob/master/LICENSE)
- [Gummy Revived](https://github.com/WinnerWind/gummy-revived) - Distributed under the [MIT License](https://github.com/WinnerWind/gummy-revived/blob/main/LICENSE)
- [Lorens](https://github.com/lorens-osman-dev/Lorens-Obsidian-Theme) - Distributed under the [MIT License](https://github.com/lorens-osman-dev/Lorens-Obsidian-Theme/blob/master/LICENSE)
- [Fancy-a-Story](https://github.com/ElsaTam/obsidian-fancy-a-story) - Distributed under the [MIT License](https://github.com/ElsaTam/obsidian-fancy-a-story/blob/main/LICENSE)
- [Borealis](https://github.com/juanchiparra/obsidian-borealis) - Distributed under the [MIT License](https://github.com/juanchiparra/obsidian-borealis/blob/main/LICENSE)
- [Origami](https://github.com/7368697661/Origami) - Distributed under the [MIT License](https://github.com/7368697661/Origami/blob/main/LICENSE)
- [Sei](https://github.com/iwa/Sei) - Distributed under the [MIT License](https://github.com/iwa/Sei/blob/main/LICENSE)
- [Composer](https://github.com/vran-dev/obsidian-composer) - Distributed under the [MIT License](https://github.com/vran-dev/obsidian-composer/blob/master/LICENSE)
- [Flexcyon](https://github.com/bladeacer/flexcyon) - Distributed under the [MIT License](https://github.com/bladeacer/flexcyon/blob/master/LICENSE)
- [FastPpuccin](https://github.com/LostViking09/obsidian-fastppuccin) - Distributed under the [GPL-3.0 License](https://github.com/LostViking09/obsidian-fastppuccin/blob/master/LICENSE)
- [Things 3](https://github.com/MrParalloid/obsidian-things) - Distributed under the [MIT License](https://github.com/MrParalloid/obsidian-things/blob/main/LICENSE)
- [SpectrumPlus](https://github.com/anotherlusitano/SpectrumPlus) - Distributed under the [MIT License](https://github.com/anotherlusitano/SpectrumPlus/blob/main/LICENSE)
- [Pomme Notes](https://github.com/MrParalloid/pomme-notes/) - Distributed under the [MIT License](https://github.com/MrParalloid/pomme-notes/blob/main/LICENSE)
- [Ribbons](https://github.com/ddspog/obsidian-ribbons-theme) - Distributed under the [Unlicense License](https://github.com/ddspog/obsidian-ribbons-theme/blob/master/LICENSE)


</details>

<details>
<summary>CSS Snippets</summary>

- [ITS Alternative Checkboxes](https://github.com/SlRvb/Obsidian--ITS-Theme/blob/main/Guide/Alternate-Checkboxes.md) - Distributed under the [GPL-2.0 License](https://github.com/SlRvb/Obsidian--ITS-Theme/blob/main/LICENSE)
- [Phoenix Checkboxes](https://github.com/RyzenFromFire/obsidian-phoenix-checkboxes) - Distributed under the [MIT License](https://github.com/RyzenFromFire/obsidian-phoenix-checkboxes/blob/main/LICENSE)

</details>

<details>
<summary>Plugins</summary>

- [Style Settings](https://github.com/mgmeyers/obsidian-style-settings) - Distributed under the [GPL-3.0 License](https://github.com/mgmeyers/obsidian-style-settings/blob/main/LICENSE.md)
- [Editor Shortcuts](https://github.com/timhor/obsidian-editor-shortcuts) - Distributed under the [MIT License](https://github.com/timhor/obsidian-editor-shortcuts)
- [Tasks](https://github.com/obsidian-tasks-group/obsidian-tasks) - Distributed under the [MIT License](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/LICENSE)
- [Snippetor](https://github.com/ebullient/obsidian-snippetor) - Distributed under the [AGPL-3.0 License](https://github.com/ebullient/obsidian-snippetor/blob/main/LICENSE)
- [ToggleList](https://github.com/thingnotok/obsidian-toggle-list) - Distributed under the [MIT License](https://github.com/thingnotok/obsidian-toggle-list/blob/master/LICENSE)

</details>

The inclusion of the Themes / CSS Snippets / Plugins in the vault are strictly for research purposes. If you are an author of any of them and would like me to remove them from this repository, please let me know by creating an issue.  

The Documentation itself (Markdown files) are under the [Unlicense License](https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/blob/main/LICENSE), unless another license is noted, especially next to code snippets from the themes.  

The Alternative Checkbox Reference Set CSS file is also under the [Unlicense License](https://github.com/damiankorcz/Alternative-Checkboxes-Reference-Set/blob/main/LICENSE) to prevent any issues with creating derivative works based on it.

The icons used in the Reference Set CSS are [Lucide](https://lucide.dev/). Lucide is distributed under the [ISC License](https://lucide.dev/license).