Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 2.18 KB

README.md

File metadata and controls

53 lines (43 loc) · 2.18 KB

UnitPlayground

This library provides canvass-like a Svelte component that encourages a deeper understanding of units. This "unit playground" aims to aid problem solvers by providing instant unit feedback, hints, and rearrangeable equations.

version build issues dependencies code style: prettier

Installation & Usage | About | Acknowledgements | License

Installation & Usage

Install

Currently, this package is only available in Svelte projects. Simply install with npm.

npm i unitplayground

Add to your project

To use the component in your project import it and place it within some container <div>. UnitPlayground will fill its parent container. Example:

+page.svelte
<script>
  import UnitPlayground from 'unitplayground'
</script>

<div class=base>
  <UnitPlayground/>
</div>

<style>
  .base {
    max-width: 100%;
    width: 90vw;
    height: 50vh;
  }
</style>

About

What is this package able to deliver? Stay tuned . . .

Acknowledgements

Thanks to the authors and maintainers of my dependencies, especially mathlive, @cortex-js/compute-engine, and unitmath. Also, thanks to my professor Robert Ordóñez for support while I was developing this project.

License

UnitPlayground is released under the MIT license.