274 lines
23 KiB
HTML
274 lines
23 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Project Structure</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff" />
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../highlight.css">
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
<!-- MathJax -->
|
|
<script async type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
</head>
|
|
<body>
|
|
<!-- Provide site root to javascript -->
|
|
<script type="text/javascript">
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script type="text/javascript">
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script type="text/javascript">
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('no-js')
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add('js');
|
|
</script>
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script type="text/javascript">
|
|
var html = document.querySelector('html');
|
|
var sidebar = 'hidden';
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
}
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../index.html">Introduction</a></li><li class="chapter-item expanded "><a href="../getting_started/index.html"><strong aria-hidden="true">1.</strong> Getting Started</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../getting_started/desktop.html"><strong aria-hidden="true">1.1.</strong> Desktop</a></li><li class="chapter-item expanded "><a href="../getting_started/web.html"><strong aria-hidden="true">1.2.</strong> Web</a></li><li class="chapter-item expanded "><a href="../getting_started/ssr.html"><strong aria-hidden="true">1.3.</strong> Server-Side Rendering</a></li><li class="chapter-item expanded "><a href="../getting_started/fullstack.html"><strong aria-hidden="true">1.4.</strong> Fullstack</a></li><li class="chapter-item expanded "><a href="../getting_started/liveview.html"><strong aria-hidden="true">1.5.</strong> Liveview</a></li><li class="chapter-item expanded "><a href="../getting_started/tui.html"><strong aria-hidden="true">1.6.</strong> Terminal UI</a></li><li class="chapter-item expanded "><a href="../getting_started/mobile.html"><strong aria-hidden="true">1.7.</strong> Mobile</a></li><li class="chapter-item expanded "><a href="../getting_started/hot_reload.html"><strong aria-hidden="true">1.8.</strong> Hot Reloading</a></li></ol></li><li class="chapter-item expanded "><a href="../describing_ui/index.html"><strong aria-hidden="true">2.</strong> Describing the UI</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../describing_ui/special_attributes.html"><strong aria-hidden="true">2.1.</strong> Special Attributes</a></li><li class="chapter-item expanded "><a href="../describing_ui/components.html"><strong aria-hidden="true">2.2.</strong> Components</a></li><li class="chapter-item expanded "><a href="../describing_ui/component_props.html"><strong aria-hidden="true">2.3.</strong> Props</a></li><li class="chapter-item expanded "><a href="../describing_ui/component_children.html"><strong aria-hidden="true">2.4.</strong> Component Children</a></li></ol></li><li class="chapter-item expanded "><a href="../interactivity/index.html"><strong aria-hidden="true">3.</strong> Interactivity</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../interactivity/event_handlers.html"><strong aria-hidden="true">3.1.</strong> Event Listeners</a></li><li class="chapter-item expanded "><a href="../interactivity/hooks.html"><strong aria-hidden="true">3.2.</strong> Hooks & Component State</a></li><li class="chapter-item expanded "><a href="../interactivity/user_input.html"><strong aria-hidden="true">3.3.</strong> User Input</a></li><li class="chapter-item expanded "><a href="../interactivity/sharing_state.html"><strong aria-hidden="true">3.4.</strong> Sharing State</a></li><li class="chapter-item expanded "><a href="../interactivity/custom_hooks.html"><strong aria-hidden="true">3.5.</strong> Custom Hooks</a></li><li class="chapter-item expanded "><a href="../interactivity/dynamic_rendering.html"><strong aria-hidden="true">3.6.</strong> Dynamic Rendering</a></li><li class="chapter-item expanded "><a href="../interactivity/router.html"><strong aria-hidden="true">3.7.</strong> Routing</a></li></ol></li><li class="chapter-item expanded "><a href="../async/index.html"><strong aria-hidden="true">4.</strong> Async</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../async/use_future.html"><strong aria-hidden="true">4.1.</strong> UseFuture</a></li><li class="chapter-item expanded "><a href="../async/use_coroutine.html"><strong aria-hidden="true">4.2.</strong> UseCoroutine</a></li><li class="chapter-item expanded "><a href="../async/spawn.html"><strong aria-hidden="true">4.3.</strong> Spawning Futures</a></li></ol></li><li class="chapter-item expanded "><a href="../best_practices/index.html"><strong aria-hidden="true">5.</strong> Best Practices</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../best_practices/error_handling.html"><strong aria-hidden="true">5.1.</strong> Error Handling</a></li><li class="chapter-item expanded "><a href="../best_practices/antipatterns.html"><strong aria-hidden="true">5.2.</strong> Antipatterns</a></li></ol></li><li class="chapter-item expanded "><a href="../publishing/index.html"><strong aria-hidden="true">6.</strong> Publishing</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../publishing/desktop.html"><strong aria-hidden="true">6.1.</strong> Desktop</a></li><li class="chapter-item expanded "><a href="../publishing/web.html"><strong aria-hidden="true">6.2.</strong> Web</a></li><li class="spacer"></li></ol></li><li class="chapter-item expanded "><a href="../fullstack/index.html"><strong aria-hidden="true">7.</strong> Fullstack</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../fullstack/getting_started.html"><strong aria-hidden="true">7.1.</strong> Getting Started</a></li><li class="chapter-item expanded "><a href="../fullstack/server_functions.html"><strong aria-hidden="true">7.2.</strong> Communicating with the Server</a></li><li class="spacer"></li></ol></li><li class="chapter-item expanded "><a href="../custom_renderer/index.html"><strong aria-hidden="true">8.</strong> Custom Renderer</a></li><li class="spacer"></li><li class="chapter-item expanded "><a href="../contributing/index.html"><strong aria-hidden="true">9.</strong> Contributing</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../contributing/project_structure.html" class="active"><strong aria-hidden="true">9.1.</strong> Project Structure</a></li><li class="chapter-item expanded "><a href="../contributing/walkthrough_readme.html"><strong aria-hidden="true">9.2.</strong> Walkthrough of Internals</a></li><li class="chapter-item expanded "><a href="../contributing/guiding_principles.html"><strong aria-hidden="true">9.3.</strong> Guiding Principles</a></li><li class="chapter-item expanded "><a href="../contributing/roadmap.html"><strong aria-hidden="true">9.4.</strong> Roadmap</a></li></ol></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|
<div class="left-buttons">
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</button>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
<button id="language-toggle" class="icon-button" type="button" title="Select language" aria-label="Select language" aria-haspopup="true" aria-expanded="false" aria-controls="language-list">
|
|
<i class="fa fa-globe"></i>
|
|
</button>
|
|
<ul id="language-list" class="language-popup" aria-label="Languages" role="menu">
|
|
<li role="none"><a href="../../en/contributing/project_structure.html"><button role="menuitem" class="language" id="light">English</button></a></li>
|
|
<li role="none"><a href="../../pt-br/contributing/project_structure.html"><button role="menuitem" class="language" id="light">Português Brasileiro</button></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<h1 class="menu-title"></h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/DioxusLabs/dioxus/edit/master/docs/guide" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/DioxusLabs/dioxus/edit/master/docs/guide/src/contributing/project_structure.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script type="text/javascript">
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="project-struture"><a class="header" href="#project-struture">Project Struture</a></h1>
|
|
<p>There are many packages in the Dioxus organization. This document will help you understand the purpose of each package and how they fit together.</p>
|
|
<h2 id="renderers"><a class="header" href="#renderers">Renderers</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/desktop">Desktop</a>: A Render that Runs Dioxus applications natively, but renders them with the system webview</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/mobile">Mobile</a>: A Render that Runs Dioxus applications natively, but renders them with the system webview. This is currently a copy of the desktop render</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/Web">Web</a>: Renders Dioxus applications in the browser by compiling to WASM and manipulating the DOM</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/liveview">Liveview</a>: A Render that Runs on the server, and renders using a websocket proxy in the browser</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/rink">Rink</a>: A Renderer that renders a HTML-like tree into a terminal</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/dioxus-tui">TUI</a>: A Renderer that uses Rink to render a Dioxus application in a terminal</li>
|
|
<li><a href="https://github.com/DioxusLabs/blitz/tree/master/blitz-core">Blitz-Core</a>: An experimental native renderer that renders a HTML-like tree using WGPU.</li>
|
|
<li><a href="https://github.com/DioxusLabs/blitz">Blitz</a>: An experimental native renderer that uses Blitz-Core to render a Dioxus application using WGPU.</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/ssr">SSR</a>: A Render that Runs Dioxus applications on the server, and renders them to HTML</li>
|
|
</ul>
|
|
<h2 id="state-managementhooks"><a class="header" href="#state-managementhooks">State Management/Hooks</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/hooks">Hooks</a>: A collection of common hooks for Dioxus applications</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/signals">Signals</a>: A experimental state management library for Dioxus applications. This currently contains a <code>Copy</code> version of UseRef</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus-std">Dioxus STD</a>: A collection of platform agnostic hooks to interact with system interfaces (The clipboard, camera, etc.).</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/fermi">Fermi</a>: A global state management library for Dioxus applications.
|
|
<a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/router">Router</a>: A client-side router for Dioxus applications</li>
|
|
</ul>
|
|
<h2 id="core-utilities"><a class="header" href="#core-utilities">Core utilities</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/core">core</a>: The core virtual dom implementation every Dioxus application uses
|
|
<ul>
|
|
<li>You can read more about the archetecture of the core <a href="https://dioxuslabs.com/blog/templates-diffing/">in this blog post</a> and the <a href="../custom_renderer/index.html">custom renderer section of the guide</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/RSX">RSX</a>: The core parsing for RSX used for hot reloading, autoformatting, and the macro</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/core-macro">core-macro</a>: The rsx! macro used to write Dioxus applications. (This is a wrapper over the RSX crate)</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus-html-macro">HTML macro</a>: A html-like alternative to the RSX macro</li>
|
|
</ul>
|
|
<h2 id="native-renderer-utilities"><a class="header" href="#native-renderer-utilities">Native Renderer Utilities</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/native-core">native-core</a>: Incrementally computed tree of states (mostly styles)
|
|
<ul>
|
|
<li>You can read more about how native-core can help you build native renderers in the <a href="../custom_renderer/index.html#native-core">custom renderer section of the guide</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/native-core-macro">native-core-macro</a>: A helper macro for native core</li>
|
|
<li><a href="https://github.com/DioxusLabs/taffy">Taffy</a>: Layout engine powering Blitz-Core, Rink, and Bevy UI</li>
|
|
</ul>
|
|
<h2 id="web-renderer-tooling"><a class="header" href="#web-renderer-tooling">Web renderer tooling</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/html">HTML</a>: defines html specific elements, events, and attributes</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/interpreter">Interpreter</a>: defines browser bindings used by the web and desktop renderers</li>
|
|
</ul>
|
|
<h2 id="developer-tooling"><a class="header" href="#developer-tooling">Developer tooling</a></h2>
|
|
<ul>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/hot-reload">hot-reload</a>: Macro that uses the RSX crate to hot reload static parts of any rsx! macro. This macro works with any non-web renderer with an <a href="https://crates.io/crates/dioxus-hot-reload">integration</a></li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/autofmt">autofmt</a>: Formats RSX code</li>
|
|
<li><a href="https://github.com/DioxusLabs/dioxus/tree/master/packages/RSX-rosetta">rsx-rosetta</a>: Handles conversion between HTML and RSX</li>
|
|
<li><a href="https://github.com/DioxusLabs/cli">CLI</a>: A Command Line Interface and VSCode extension to assist with Dioxus usage</li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../contributing/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next" href="../contributing/walkthrough_readme.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../contributing/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next" href="../contributing/walkthrough_readme.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
window.playground_line_numbers = true;
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
<script src="../ace.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../editor.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../mode-rust.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../theme-dawn.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../theme-tomorrow_night.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</body>
|
|
</html>
|