Skip to content

Add implementation types to examples table #2361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ranile merged 2 commits into from
Jan 19, 2022
Merged

Add implementation types to examples table #2361

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72bada6
Add implemntation types to examples table
voidpumpkin Jan 12, 2022
a0e1034
duplicate word
voidpumpkin Jan 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 31 additions & 26 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,32 +26,37 @@ As an example, check out the TodoMVC example here: <https://examples.yew.rs/todo

## List of examples

| Example | Description |
| -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| [agents](agents) | Cross-component communication using [Agents](https://yew.rs/docs/concepts/agents) |
| [boids](boids) | Yew port of [Boids](https://en.wikipedia.org/wiki/Boids) |
| [contexts](contexts) | A technical demonstration of Context API. |
| [counter](counter) | Simple counter which can be incremented and decremented |
| [dyn_create_destroy_apps](dyn_create_destroy_apps) | Uses the function `start_app_in_element` and the `AppHandle` struct to dynamically create and delete Yew apps |
| [file_upload](file_upload) | Uses the `gloo::file` to read the content of user uploaded files |
| [function_todomvc](function_todomvc) | Implementation of [TodoMVC](http://todomvc.com/) using function components and hooks. |
| [futures](futures) | Demonstrates how you can use futures and async code with Yew. Features a Markdown renderer. |
| [game_of_life](game_of_life) | Implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) |
| [inner_html](inner_html) | Embeds an external document as raw HTML by manually managing the element |
| [js_callback](js_callback) | Interacts with JavaScript code |
| [keyed_list](keyed_list) | Demonstrates how to use keys to improve the performance of lists |
| [mount_point](mount_point) | Shows how to mount the root component to a custom element |
| [nested_list](nested_list) | Renders a styled list which tracks hover events |
| [node_refs](node_refs) | Uses a [`NodeRef`](https://yew.rs/docs/concepts/components/refs) to focus the input element under the cursor |
| [password_strength](password_strength) | A password strength estimator implemented in Yew |
| [portals](portals) | Renders elements into out-of-tree nodes with the help of portals |
| [router](router) | The best yew blog built with `yew-router` |
| [store](store) | Showcases the `yewtil::store` API |
| [timer](timer) | Demonstrates the use of the interval and timeout services |
| [todomvc](todomvc) | Implementation of [TodoMVC](http://todomvc.com/) |
| [two_apps](two_apps) | Runs two separate Yew apps which can communicate with each other |
| [web_worker_fib](web_worker_fib) | Calculate fibonacci value of a number in a web worker thread |
| [webgl](webgl) | Controls a [WebGL canvas](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial/Getting_started_with_WebGL) from Yew |
- CT - Type of most components , "F" for function components and "S" for struct components, "SF" for a mix of both.

| Example | CT | Description |
| -------------------------------------------------- | -- | ---------------------------------------------------------------------------------------------------------------------------------- |
| [agents](agents) | S | Cross-component communication using [Agents](https://yew.rs/docs/concepts/agents) |
| [boids](boids) | S | Yew port of [Boids](https://en.wikipedia.org/wiki/Boids) |
| [contexts](contexts) | F | A technical demonstration of Context API. |
| [counter](counter) | S | Simple counter which can be incremented and decremented |
| [dyn_create_destroy_apps](dyn_create_destroy_apps) | S | Uses the function `start_app_in_element` and the `AppHandle` struct to dynamically create and delete Yew apps |
| [file_upload](file_upload) | S | Uses the `gloo::file` to read the content of user uploaded files |
| [function_todomvc](function_todomvc) | F | Implementation of [TodoMVC](http://todomvc.com/) using function components and hooks. |
| [futures](futures) | S | Demonstrates how you can use futures and async code with Yew. Features a Markdown renderer. |
| [game_of_life](game_of_life) | S | Implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) |
| [inner_html](inner_html) | S | Embeds an external document as raw HTML by manually managing the element |
| [js_callback](js_callback) | S | Interacts with JavaScript code |
| [keyed_list](keyed_list) | S | Demonstrates how to use keys to improve the performance of lists |
| [mount_point](mount_point) | S | Shows how to mount the root component to a custom element |
| [nested_list](nested_list) | S | Renders a styled list which tracks hover events |
| [node_refs](node_refs) | S | Uses a [`NodeRef`](https://yew.rs/docs/concepts/components/refs) to focus the input element under the cursor |
| [password_strength](password_strength) | SF | A password strength estimator implemented in Yew |
| [portals](portals) | S | Renders elements into out-of-tree nodes with the help of portals |
| [router](router) | S | The best yew blog built with `yew-router` |
| [simple_ssr](simple_ssr) | F | Demonstrates server-side rendering |
| [store](store) | S | Showcases the `yewtil::store` API |
| [suspense](suspense) | F | This is an example that demonstrates <Suspense /> support |
| [function_memory_game](function_memory_game) | F | Implementation of [Memory Game](https://github.com/bradlygreen/Memory-Game) |
| [timer](timer) | S | Demonstrates the use of the interval and timeout services |
| [todomvc](todomvc) | S | Implementation of [TodoMVC](http://todomvc.com/) |
| [two_apps](two_apps) | S | Runs two separate Yew apps which can communicate with each other |
| [web_worker_fib](web_worker_fib) | S | Calculate fibonacci value of a number in a web worker thread |
| [webgl](webgl) | S | Controls a [WebGL canvas](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial/Getting_started_with_WebGL) from Yew |

## Next steps

Expand Down