zeroarcsoftware / carbondream

Reactjs Annotation Component

carbondream

Reactjs Annotation Engine

Carbondream is an annotation engine written purely in ReactJS. It was inspired by Annotator and heavily borrows from the UX.

Using it

To use Carbondream:

• Install the component through NPM

• Require it

• Pass it a list of annotations and the following props:

Contributing

First, setup your local environment:

git clone [email protected]:ZeroarcSoftware/carbondream.git
cd carbondream
npm install

Link the project to your local target environment:

sudo npm link

Next, build the project:

npm run build

Or, alternatively, use babel watch to continously watch for changes:

NODE_ENV=production npx babel src/ -d dist/ --extensions '.ts,.tsx' -w

carbondream's Issues

Blocky arrows on bubbles in Safari

Documentation or reference to use this tool in React app

Hi there . If there are any documentation available for this tool to use it in React app. Please let me know its very important. Thanks

Does not properly handle page scrolling

Scroll down the page and add a marker. Carbondream does not calculate correct vertical offset.

Some hints at extending the annotations

Can you give some hints on how we would extend the annotator to have 2 new features?

1. We need to convert the React document into a Word document at some point, thus we need to add a number in the top left of each annotation to identify it in the exported document. A small circle with a number in it would work.
2. The UI Design calls for a palette that has 5 different rectangles to be used for annotation, with different cross hatch patterns scaled to fill the rectangle.

'$' is not recognized as an internal or external command,

I just cloned this project and trying install node modules( npm install ). I got an error like

NODE_ENV=production $(npm bin)/babel src/ -d lib/ && cp -r node_modules/font-awesome/css web && cp -r node_modules/font-awesome/fonts web && flow-copy-source -v src lib

I resolved this by adding SET before NODE_ENV and Then I got one more error

'$' is not recognized as an internal or external command,

I'm using windows 10. Can someone help me on this.

Support scrollable pages

It would be ideal to be able to have a mode that allowed annotations to exist outside of the view port and scroll into view with the parent div.

Swap Save and Cancel buttons on annotation form to match Candid standard

Candid form buttons for Cancel/Submit always show Cancel before the Submit/Add/Save button.

online demo please :)?

For react.rocks -- thanks!