search

nteract / semiotic

A data visualization framework combining React & D3
https://semioticv1.nteract.io/
Other
2.43k stars 133 forks source link

accessing types from semiotic v2 #527

Open cainlevy opened 4 years ago

cainlevy commented 4 years ago

When using semiotic@2.0.0-rc5, I am able to access the types only when I import components by name from the dist/ directory. This is a tricky thing to discover because the live code examples use lib/.

Types Included

import XYFrame from 'semiotic/dist/XYFrame'

Types Not Included

import XYFrame from 'semiotic/lib/XYFrame';
import {XYFrame} from 'semiotic';

Thoughts

Is importing components by pathname the right pattern? It would be helpful to clarify dist vs lib, especially in the code examples on https://semiotic.nteract.io/.

Should I also be able to import components from the package index? Might need a "types" entry in package.json.

emeeks commented 4 years ago

These are good points. I'll dig into it and see what I can do to clean this up. I've been working with typescript for a while but I'm still rather new to publishing types. Happy to review a PR if you want to dive into it.

alexeyraspopov commented 2 years ago

I believe this is now fixed by #594 and available in 2.0.0-rc.19.

Warning: only named imports are now available. Use import { XYFrame } from "semiotic" over import XYFrame from 'semiotic/dist/XYFrame'