Code Monkey home page Code Monkey logo

svg's Introduction

curvenote.dev

@curvenote/svg

Ink-Basic on npm MIT License Documentation

The goal of @curvenote/svg is to provide web-components for interactive scientific writing, reactive documents and explorable explanations. This library provides basic charting and diagram capabilities through basic, reactive SVG graphics.

Radius

<r-var name="a" value="3"></r-var>
<r-var name="b" value="3"></r-var>
<r-var name="r" :value="Math.sqrt(a*a + b*b)"></r-var>
<r-svg-chart
  xlim="[-5, 5]"
  ylim="[-5, 5]"
  height="400"
  width="400"
  x-axis-location="origin"
  y-axis-location="origin"
  style="text-align: center;"
>
  <r-svg-eqn
    :domain="[0, Math.atan2(b, a)]"
    eqn="[r * Math.cos(t), r * Math.sin(t)]"
    parameterize="t"
    stroke="#333"
    stroke-width="1"
    stroke-dasharray="3"
  ></r-svg-eqn>
  <r-svg-path
    :data="[[0, 0],[r * Math.cos(Math.atan2(b, a)), r * Math.sin(Math.atan2(b, a))]]"
    stroke="#333"
    stroke-width="1"
    stroke-dasharray="3"
  ></r-svg-path>
  <r-svg-text
    :x="(r/2) * Math.cos(Math.atan2(b, a) / 2)"
    :y="(r/2) * Math.sin(Math.atan2(b, a) / 2)"
    :text="Math.round(Math.atan2(b, a)*180/Math.PI) + '°'"
  ></r-svg-text>
  <r-svg-node :x="a" :y="b" :drag="{a: x, b: y}" fill="#ff7f0e"></r-svg-node>
</r-svg-chart>

Getting Started

@curvenote/svg is based on web-components, which creates custom HTML tags so that they can make writing documents easier. To get started, copy the built javascript file to the head of your page:

<script src="https://unpkg.com/@curvenote/svg"></script>

You can also download the latest release from GitHub. If you are running this without a web server, ensure the script has charset="utf-8" in the script tag. You can also install from npm:

>> npm install @curvenote/svg

You should then be able to extend the package as you see fit:

import components from '@curvenote/svg';

Note that the npm module does not setup the @curvenote/runtime store, nor does it register the components. See the curvenote.ts file for what the built package does to setup the store and register the components.

Documentation

See https://curvenote.dev for full documentation.

Basic Components

  • r-svg-chart
  • r-svg-text
  • r-svg-path
  • r-svg-eqn
  • r-svg-circle
  • r-svg-image
  • r-svg-node

svg's People

Contributors

neilhacker avatar rowanc1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

svg's Issues

r-svg-eqn illegally sets attributes in its constructor

Custom elements are not allowed to set their own attributes in the constructor. This is because new SomeElement() should be created without attributes, like every built-in element.

<r-svg-eqn> does this here: https://github.com/curvenote/svg/blob/main/src/components/equation.ts#L60

This limitation is enforced by browsers, but only when elements are defined before parsed in the main page. This happens when using the bundled script from https://unpkg.com/@curvenote/article. Since that script is a classic script, and not a module, it is executed before the rest of the page parses, then when <r-svg-eqn> is parsed it's instantiated, sets an attribute, and errors.

Here's a live reproduction that starts our not working. You can see the error in the console.

You can make it work by adding async to the curvenote script, causing it to run after the page is parsed, or by commenting out the <r-svg-eqn> elements.

In this case this can probably be fixed by giving the stroke property a default value instead of setting the attribute, which is also how reflected properties in built-in elements work.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.