fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-06-23 09:41:33 +00:00
Code Issues Projects Releases Wiki Activity
Files
80899abf84e0ebb45cfcb281ac01111869f918d9
wasm-bindgen/guide/src/examples/index.md

25 lines
1.2 KiB
Markdown
Raw Normal View History

Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
# Examples of using `wasm-bindgen`, `js-sys`, and `web-sys`
This subsection contains examples of using the `wasm-bindgen`, `js-sys`, and
`web-sys` crates. Each example should have more information about what it's
doing.
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
These examples all assume familiarity with `wasm-bindgen`, `wasm-pack`, and
building a Rust and WebAssembly project. If you're unfamiliar with these check
Clarify some introductory docs * Note that after the game of life tutorial there's also wasm-pack tutorials * Ensure that the hello world example is clear that webpack isn't required inline in addition to the text on other pages.
2019-03-21 08:44:53 -07:00
out the [Game of Life tutorial][gol] or [wasm pack tutorials][wpt] to help you
get started.
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
The source code for all examples can also be [found online][code] to download
and run locally. Most examples are configured with Webpack/`wasm-pack` and can
Convert all examples to using wasm-pack This commit migrates all our examples to using `wasm-pack build` to compile their code and run `wasm-bindgen`. This should make it a bit easier to understand the examples as there's less to follow during the build step. Webpack projects are all using `@wasm-tool/wasm-pack-plugin` as well so the build step is simple `npm run serve`. Other examples which retain `build.sh` are just using `wasm-pack build` now
2019-01-08 15:14:15 -08:00
be built with `npm run serve`. Other examples which don't use Webpack are
Clarify some introductory docs * Note that after the game of life tutorial there's also wasm-pack tutorials * Ensure that the hello world example is clear that webpack isn't required inline in addition to the text on other pages.
2019-03-21 08:44:53 -07:00
accompanied with instructions or a `build.sh` showing how to build it.
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
Note that most examples currently use Webpack to assemble the final output
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
artifact, but this is not required! You can review the [deployment
documentation][deploy] for other options of how to deploy Rust and WebAssembly.
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
[code]: https://github.com/rustwasm/wasm-bindgen/tree/master/examples
Update a few links here and there with doc restructuring
2019-03-08 05:58:22 -08:00
[gol]: https://rustwasm.github.io/docs/book/
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
[deploy]: ../reference/deployment.html
Clarify some introductory docs * Note that after the game of life tutorial there's also wasm-pack tutorials * Ensure that the hello world example is clear that webpack isn't required inline in addition to the text on other pages.
2019-03-21 08:44:53 -07:00
[wpt]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html
Reference in New Issue Copy Permalink