antontranelis/utopia-ui
1
0
Fork 0
mirror of https://github.com/utopia-os/utopia-ui.git synced 2025-12-13 07:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

install typedoc

Browse Source
This commit is contained in:
Ulf Gebhardt 2025-01-31 08:29:22 +01:00
parent 8f2310b73f
commit f75767f286
Signed by: ulfgebhardt
GPG Key ID: DA6B843E748679C9
53 changed files with 4191 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/.nojekyll Normal file
View File

@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

1
docs/assets/hierarchy.js Normal file
View File

@ -0,0 +1 @@
window.hierarchyData = 'eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm'

22
docs/assets/highlight.css Normal file
View File

@ -0,0 +1,22 @@
:root {
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@media (prefers-color-scheme: light) { :root {
--code-background: var(--light-code-background);
} }
@media (prefers-color-scheme: dark) { :root {
--code-background: var(--dark-code-background);
} }
:root[data-theme='light'] {
--code-background: var(--light-code-background);
}
:root[data-theme='dark'] {
--code-background: var(--dark-code-background);
}
pre, code { background: var(--code-background); }

21
docs/assets/icons.js Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/assets/icons.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

2208
docs/assets/main.js Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/assets/navigation.js Normal file
View File

@ -0,0 +1,2 @@
window.navigationData =
'eJyNlk1PwkAQhv9Lz0QvxgM3IJqQiKKgF+NhpUO7oeyuu1M+YvzvdoHSNszOciM88z6hw8zA52+CsMOknwyMmeVQFEkvMQLz6p1lqRYotXK3NbvJce0LVlKlSf/+7q/XxBHBofD1j9quSUu3hJOVmE+t3sgULGlqcUYzEjadigwoRc24uFYICsn0ETHhMcI61IiaReIfErahuGdM/Ens6c4dABfUmVShnp0hI5gI87IBW4h9yNKtYFV2BRjqQkM5hU4FOdEHwAa1GokCVCrIPrY5ozk9qP/G3FilsAs1hSxkxFOwa+mcz1K6FuYk2pRmWCJqRUoaHJOMclisvvVurExJLsxlVUw5Q2HxQaW8slMVU86r1wMLgld2qq5RxnVRldVLWUDoXrRwXBLalxZmJK9ldaLJkToSJvoGP75kKpzb6vDhJcoY6QwKWOBQ7yjVGUYF744+hw1lFfgM29hzXVZxyuqXa0hflhNiw5kqTfBznCmrqA6NMHT+gLjwaedCk9bmjGYuMnLQ/PtcLLbE1+4vu7rXbK2vCfWgZlxcYgH+bwiZryEj8GNbTR1KRTeyzTkNaiPFhJ6GM7wQfP0DcPeEig=='

2
docs/assets/search.js Normal file
View File

@ -0,0 +1,2 @@
window.searchData =
'eJytmt9v2zgMx/8X32vQVaSTNn3bijugwO2ud/vxUhSDm6itMcf2bGXtUPR/P9F2aiqiV2a4t9gUv5aoDylZzlPSVA9tcnb1lHzNy3VytkhnSZltbHKWfHJVnWfvszqZJdum8Hdut+XK5VXZvnmxHd27TeEbrIqsba1XSpLnmSD2Z/bDNoJQd18r8jG7awUNuq2VuLTNJm9b8hOUmFUreOHs5o+q2QhqO9NPpcwxjGJ1U9Uff9RW6lug9hu1dENLpjtL6qyxpeMdm3jW2t5m28JdeqHXHzc0rofG6ifuBepzbh8mnkWm/y9QL2rKQHUd+/VAjY9TB2rviRzRqt7WH+2je9vY7KKst04iNWqkzgDy/OCyxv1ern8qHzQ6SJ469mrPD5d9t3WuKqc0e6u6lvgeTOC4M2mldnGakOPmg4Z7fm9XX2+qx59GMmiklX9b1x/ubVEIojuTVuq8Kh1RHSsNFnUU87V9l0lrxGDRC/n0EletwaKO0tbd+6z/7h8vdYub1ctgdZeXl9mdlZbCnU0/0LtyW0+ojUat3L/229a27tK3eqia9YSu0ErdX+v+sg+v6MeNtPKfWtt4b5eX4i6Bm9Vp2FS3eWEnEptZDxSc2DAwq1bwH5oMabi9QSvzvlpnUjXo7qtLau4Ke541a6mm7mzqupJNIrIzqQeX1X9/t02R/ZgQDBtoZQcXWszbi3JtHyfUxXb6ianK86yw5VosjdysT8PCrhylg5h+O6O6SjrnScvIfQLrvRb6aWu+2qk1ejQesuBPraQHb0de25790s6sj/276nFyXrxNErueJTmBlZw9JR42en/x9+EIj5a+5W1uizW94/XP8a7VZtMv2etqte1+Xg/NPvuHVA017lu/OU5mV8czxKP5/OT6ena1c+4M3Y2dxninczT+ykiOJnI0gSP4K5AcIXKEwBH9FUqOGDli4Jj6q1RyTCPHNHCc+6v5DE6P0nQZOM4jx3nguPBXC8lxETkuAscTf3UidfUkcjwJHE+nunoaOZ4Gjsupri4jx2UIAPFwKhIQs2P24CEklqKvgE/IjyEqjMisiREyIUOGyDAytzFGJuTIEB1GZNfEKJmQJUOEGJFfE+NkQp4MUWJEhk2MlAmZMkSKmYvOMVYm5MoQLWYhOsdomZAtQ8QYkWcT42VCvoCQMSJgEAMGIWDQlSeRMIgJg70K1ZUokTAQilRIGBAzIBIGMWEQEgbEDMjVMSYMQsKAmAGRMIgJg5AwIGZAJAxiwiAkDIgZEAmDmDAICQNiBkTCICYMQsKAmAGRMIgJg5AwJGZAJAxjwjAkDIkZEAnDmDAMCUNiBkXCMCYM99bBbiEUCUNhKQwJQ2IGRcIwJgxDwpCYQXkNjgnDkDAkZlAkDGPCMCQMiRkUCcOYMAwJQ2IGRcIwJgxDwpCYQZEwjAnDkLCUmEGRsDQmLA0JS4kZFAlLY8KGW91W0e8RnV1f9FtGv9PL6rrtj4Oeki/DTtIvCMO+9CnxNf/s6fl53Dn6K7Z5JBs9Kxv3+bfdm8CohkwNlWpbd1+/nL6wji1HKV+YNVIr/8JYdy9nrEfHrEegk9kddbHOLFiUTlUq4QnxKMWUFr3rUqVHZ1r74U5HrVQt8r170xpFTkYR3YwV/TceFh0WHJ0CHYHtzxSwmQLdTG2yuurfuqNpZ33ypU8nRq+a+9FBNl+om/lNf8jCRnbKNI6VGlW5ejkPYN1BJjVXSQ0RoqlvO5UoVsA0dRzV/PMaU2JCOh062r4ZjvsZUJyoA5RWwyF53r+uM0GWKWahF2zpTN9PQiTIipPRMd/pOfvoFW0W6TFCjI6QF714sCyRjC6R6v5Ecr++AIMfdPAPSvtpBGxhAF2ZYV/0Rh0mM+/9dN36Npyfsh6xuge6Etz0Z+L1cGgdFTCWR6DLo7Y77rmhoyCWRQyuVAdXr7Ntw7qMjHrUUd9aV9qHyRGyBAdd9Wn9un4T1jDDIm90kW+7rxxRd1iZAF2ZaHcfjVh3WO6BLvd2ZWGfcsPiY3Txcd1/HdiYWGd0AlMlBdm4Ut24xHKCbLpQN12kE8WGjczossPRx4RV96GBBYhlB+qyg/KifflixKRYfoAuP7bdH2L2CGL1VhFnvzWv89oWeek9rq6fn/8DynmJeQ=='

1610
docs/assets/style.css Normal file
View File

File diff suppressed because it is too large Load Diff

1
docs/functions/AppShell.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/AttestationForm.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/AuthProvider.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/CardPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Content.html Normal file
View File

File diff suppressed because one or more lines are too long

3
docs/functions/ItemForm.html Normal file
View File

File diff suppressed because one or more lines are too long

3
docs/functions/ItemView.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Layer.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/LoginPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/MapOverlayPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/MarketView.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Modal.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/MoonCalendar.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/OverlayItemsIndexPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Permissions.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/PopupButton.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/PopupCheckboxInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/PopupStartEndInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/PopupTextAreaInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/PopupTextInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/ProfileForm.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/ProfileView.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Quests.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/RequestPasswordPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/SelectBox.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/SelectUser.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/SetNewPasswordPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/SideBar.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/SignupPage.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Sitemap.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/StartEndView.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/Tags.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/TextAreaInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/TextInput.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/TextView.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/TitleCard.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/UserSettings.html Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/functions/UtopiaMap.html Normal file
View File

File diff suppressed because one or more lines are too long

93
docs/index.html Normal file
View File

@ -0,0 +1,93 @@
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>utopia-ui</title><meta name="description" content="Documentation for utopia-ui"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">utopia-ui</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>utopia-ui</h1></div><div class="tsd-panel tsd-typography"><a id="utopia-ui-npm-version--build-status-license" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Utopia UI <a href="https://www.npmjs.com/package/utopia-ui"><img src="https://img.shields.io/npm/v/utopia-ui.svg" alt="npm version"></a> <img src="https://img.shields.io/github/actions/workflow/status/utopia-os/utopia-ui/test.build.yml?branch=main" alt="Build Status"> <img src="https://img.shields.io/github/license/utopia-os/utopia-ui" alt="License"><a href="#utopia-ui-npm-version--build-status-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><strong>UI Framework for Real-Life-Networking-Apps</strong></p>
<p><em>Real change happens in real life when we meet in person and connect as local communities manifesting their ideas with the earth. When we help each other to step out of our bubbles at home and start building common infrastructure to meet human needs in harmony with Mother Earth.</em></p>
<p><em>That is why Utopia UI exists. It is a UI kit for minimalist, fast, intuitive and mobile-first map apps, as a tool for local connection and decentralised networking. We believe in maps as the perfect link between digital tools and real life action</em></p>
<p><em>It can work with any backend or p2p database and any kind of data structure.</em></p>
<a id="mission" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Mission<a href="#mission" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Utopia UIs mission is to provide open source building blocks to create beautiful applications with a focus on real life impact, local communities and gamification.</p>
<p>The building blocks are designed to allow different networks and communities to assemble their map and app for their specific needs and purpose.</p>
<p>It is the base of <a href="https://github.com/utopia-os/utopia-map">Utopia Map</a> and <a href="https://github.com/utopia-os/utopia-game">Utopia Game</a>.</p>
<a id="features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<li>Interactive Component Map with customizable Layers (like Projects, Event, People)</li>
<li>Flexible API-Interface to make it work with every backend or p2p database</li>
<li>Create, Update, Delete Items</li>
<li>User authentification API-Interface</li>
<li>Customizable Profiles for users and other items</li>
<li>App shell with navigation bar and sidebar</li>
</ul>
<a id="getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ol>
<li>
<p>If you want to use <strong>Utopia UI</strong> in your project, check out <a href="/examples"><code>/exampes</code></a> to see how to use its components.</p>
</li>
<li>
<p>If you like to contribute to our library, see the <a href="/CONTRIBUTING.md">Contribution Guide</a> to see how to setup a development environment on your local machine.</p>
</li>
</ol>
<a id="components" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Components<a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><img src="media/Components.svg" alt="Utopia UI Components"></p>
<a id="map-component" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Map Component<a href="#map-component" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The map shows various Layers (like places, events, profiles ...) of Items at their respective position whith nice and informative Popup and Profiles.</p>
<p>Tags, colors and clusters help to retain the overview.</p>
<a id="map-options" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Map Options<a href="#map-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>height</code></td>
<td><code>string</code></td>
<td><code>'400px'</code></td>
<td>No</td>
<td>height of the map</td>
</tr>
<tr>
<td><code>width</code></td>
<td><code>string</code></td>
<td><code>'100vw'</code></td>
<td>No</td>
<td>width of the map</td>
</tr>
<tr>
<td><code>center</code></td>
<td><code>LatLng</code></td>
<td><code>[50.6, 9.5]</code></td>
<td>No</td>
<td>initial map position</td>
</tr>
<tr>
<td><code>zoom</code></td>
<td><code>number</code></td>
<td><code>10</code></td>
<td>No</td>
<td>initial zoom level</td>
</tr>
</tbody>
</table>
<a id="layer-options" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Layer Options<a href="#layer-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>...</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<a id="join-the-community" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Join the community<a href="#join-the-community" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><em>This Library is in alpha stage. You are very welcome to participate in the development</em></p>
<p><em>We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.</em></p>
<p><a href="https://t.me/UtopiaMap">https://t.me/UtopiaMap</a></p>
<a id="support-us" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Support us<a href="#support-us" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a href="https://opencollective.com/utopia-project">
<img width="300" src="https://opencollective.com/utopia-project/donate/button@2x.png?color=blue" />
</a></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#utopia-ui-npm-version--build-status-license"><span>Utopia UI npm version <wbr/>Build <wbr/>Status <wbr/>License</span></a><ul><li><a href="#mission"><span>Mission</span></a></li><li><a href="#features"><span>Features</span></a></li><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#components"><span>Components</span></a></li><li><a href="#map-component"><span>Map <wbr/>Component</span></a></li><li><ul><li><a href="#map-options"><span>Map <wbr/>Options</span></a></li><li><a href="#layer-options"><span>Layer <wbr/>Options</span></a></li></ul></li><li><a href="#join-the-community"><span>Join the community</span></a></li><li><a href="#support-us"><span>Support us</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">utopia-ui</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

3
docs/media/Components.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

1
docs/modules.html Normal file
View File

File diff suppressed because one or more lines are too long

183
package-lock.json generated
View File

@ -62,6 +62,7 @@
"rollup-plugin-postcss": "^4.0.2",
"rollup-plugin-typescript2": "^0.32.1",
"tailwindcss": "^3.3.1",
"typedoc": "^0.27.6",
"typescript": "^5.7.3"
},
"peerDependencies": {
@ -164,6 +165,18 @@
"url": "https://opencollective.com/eslint"
}
},
"node_modules/@gerrit0/mini-shiki": {
"version": "1.27.2",
"resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-1.27.2.tgz",
"integrity": "sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og==",
"dev": true,
"license": "MIT",
"dependencies": {
"@shikijs/engine-oniguruma": "^1.27.2",
"@shikijs/types": "^1.27.2",
"@shikijs/vscode-textmate": "^10.0.1"
}
},
"node_modules/@heroicons/react": {
"version": "2.0.18",
"resolved": "https://registry.npmjs.org/@heroicons/react/-/react-2.0.18.tgz",
@ -352,6 +365,35 @@
"dev": true,
"license": "MIT"
},
"node_modules/@shikijs/engine-oniguruma": {
"version": "1.29.2",
"resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.29.2.tgz",
"integrity": "sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==",
"dev": true,
"license": "MIT",
"dependencies": {
"@shikijs/types": "1.29.2",
"@shikijs/vscode-textmate": "^10.0.1"
}
},
"node_modules/@shikijs/types": {
"version": "1.29.2",
"resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.29.2.tgz",
"integrity": "sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==",
"dev": true,
"license": "MIT",
"dependencies": {
"@shikijs/vscode-textmate": "^10.0.1",
"@types/hast": "^3.0.4"
}
},
"node_modules/@shikijs/vscode-textmate": {
"version": "10.0.1",
"resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.1.tgz",
"integrity": "sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==",
"dev": true,
"license": "MIT"
},
"node_modules/@tanstack/query-core": {
"version": "5.17.8",
"resolved": "https://registry.npmjs.org/@tanstack/query-core/-/query-core-5.17.8.tgz",
@ -413,9 +455,10 @@
"dev": true
},
"node_modules/@types/hast": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.3.tgz",
"integrity": "sha512-2fYGlaDy/qyLlhidX42wAH0KBi2TCjKMH8CHmBXgRlJ3Y+OXTiqsPQ6IWarZKwF1JoUcAJdPogv1d4b0COTpmQ==",
"version": "3.0.4",
"resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz",
"integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==",
"license": "MIT",
"dependencies": {
"@types/unist": "*"
}
@ -4013,6 +4056,16 @@
"resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz",
"integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg=="
},
"node_modules/linkify-it": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz",
"integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==",
"dev": true,
"license": "MIT",
"dependencies": {
"uc.micro": "^2.0.0"
}
},
"node_modules/loader-utils": {
"version": "3.2.1",
"resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-3.2.1.tgz",
@ -4097,6 +4150,13 @@
"node": ">=10"
}
},
"node_modules/lunr": {
"version": "2.3.9",
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz",
"integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==",
"dev": true,
"license": "MIT"
},
"node_modules/make-dir": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
@ -4112,6 +4172,37 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/markdown-it": {
"version": "14.1.0",
"resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz",
"integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==",
"dev": true,
"license": "MIT",
"dependencies": {
"argparse": "^2.0.1",
"entities": "^4.4.0",
"linkify-it": "^5.0.0",
"mdurl": "^2.0.0",
"punycode.js": "^2.3.1",
"uc.micro": "^2.1.0"
},
"bin": {
"markdown-it": "bin/markdown-it.mjs"
}
},
"node_modules/markdown-it/node_modules/entities": {
"version": "4.5.0",
"resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
"integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
"dev": true,
"license": "BSD-2-Clause",
"engines": {
"node": ">=0.12"
},
"funding": {
"url": "https://github.com/fb55/entities?sponsor=1"
}
},
"node_modules/mdast-util-find-and-replace": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/mdast-util-find-and-replace/-/mdast-util-find-and-replace-3.0.1.tgz",
@ -4290,6 +4381,13 @@
"integrity": "sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==",
"dev": true
},
"node_modules/mdurl": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz",
"integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==",
"dev": true,
"license": "MIT"
},
"node_modules/merge2": {
"version": "1.4.1",
"resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
@ -5924,6 +6022,16 @@
"node": ">=6"
}
},
"node_modules/punycode.js": {
"version": "2.3.1",
"resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
"integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">=6"
}
},
"node_modules/queue-microtask": {
"version": "1.2.3",
"resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
@ -7195,6 +7303,68 @@
"url": "https://github.com/sponsors/ljharb"
}
},
"node_modules/typedoc": {
"version": "0.27.6",
"resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.6.tgz",
"integrity": "sha512-oBFRoh2Px6jFx366db0lLlihcalq/JzyCVp7Vaq1yphL/tbgx2e+bkpkCgJPunaPvPwoTOXSwasfklWHm7GfAw==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
"@gerrit0/mini-shiki": "^1.24.0",
"lunr": "^2.3.9",
"markdown-it": "^14.1.0",
"minimatch": "^9.0.5",
"yaml": "^2.6.1"
},
"bin": {
"typedoc": "bin/typedoc"
},
"engines": {
"node": ">= 18"
},
"peerDependencies": {
"typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x"
}
},
"node_modules/typedoc/node_modules/brace-expansion": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
"integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
"dev": true,
"license": "MIT",
"dependencies": {
"balanced-match": "^1.0.0"
}
},
"node_modules/typedoc/node_modules/minimatch": {
"version": "9.0.5",
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz",
"integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==",
"dev": true,
"license": "ISC",
"dependencies": {
"brace-expansion": "^2.0.1"
},
"engines": {
"node": ">=16 || 14 >=14.17"
},
"funding": {
"url": "https://github.com/sponsors/isaacs"
}
},
"node_modules/typedoc/node_modules/yaml": {
"version": "2.7.0",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.0.tgz",
"integrity": "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==",
"dev": true,
"license": "ISC",
"bin": {
"yaml": "bin.mjs"
},
"engines": {
"node": ">= 14"
}
},
"node_modules/typescript": {
"version": "5.7.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.3.tgz",
@ -7209,6 +7379,13 @@
"node": ">=14.17"
}
},
"node_modules/uc.micro": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz",
"integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==",
"dev": true,
"license": "MIT"
},
"node_modules/unbox-primitive": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz",

2
package.json
View File

@ -10,6 +10,7 @@
"build": "rollup -c",
"start": "rollup -c -w",
"test:lint:eslint": "eslint --ext .ts,.tsx,.js,.jsx,.cjs,.mjs,.json,.yml,.yaml --max-warnings 0 .",
"docs:generate": "typedoc src/index.tsx",
"update": "npx npm-check-updates"
},
"files": [
@ -49,6 +50,7 @@
"rollup-plugin-postcss": "^4.0.2",
"rollup-plugin-typescript2": "^0.32.1",
"tailwindcss": "^3.3.1",
"typedoc": "^0.27.6",
"typescript": "^5.7.3"
},
"peerDependencies": {

3
tsconfig.json
View File

@ -2,7 +2,7 @@
"compilerOptions": {
"outDir": "dist",
"module": "esnext",
"target": "es5",
"target": "ESNext",
"lib": ["es6", "dom","es2015", "es2016", "es2017", "es2020"],
"sourceMap": true,
"allowJs": false,
@ -16,6 +16,7 @@
"strictNullChecks": true,
"noUnusedLocals": false,
"noUnusedParameters": true,
"allowSyntheticDefaultImports": true,
"paths": {
"#components/*": ["./src/Components/*"],
"#utils/*": ["./src/Utils/*"],