react-timeline-9000 icon indicating copy to clipboard operation
react-timeline-9000 copied to clipboard

Update/Make documentation

Open lilfolr opened this issue 3 years ago • 2 comments

Current readme is a mess, and our documentation is a not-very useful export of props.
Update the documentation to include [ ] Examples & getting started [##250] [ ] Useful descriptions of props & which ones are required (#249 would assist here)

lilfolr avatar Feb 07 '22 01:02 lilfolr

@lilfolr hey, any updates here? Or maybe you can just quickly add some installation guide to README?

I cannot make Timeline component work.

I tried installing the package via npm install react-timeline-9000 and got the same error as in https://github.com/React9k/react-timeline-9000/issues/250

And I tried to build the lib manually:

  • cloned this repo
  • run make
  • tried to use Timeline component in the following way:
import React from 'react';
import ReactDOM from 'react-dom';

import Timeline from './react-timeline-9000'

const App = () => {
    const endDate = new Date()
    endDate.setDate(endDate.getDate() + 1);

    return (
        <Timeline
            items={[]}
            groups={[]}
            startDate={new Date()}
            endDate={endDate}
            useMoment={false}
        />
    );
}

ReactDOM.render(
    <App />,
    document.getElementById('root')
);

And got the following error:

Uncaught Error: Unable to find node on an unmounted component.
    at findHostInstanceWithWarning (react-dom.development.js?5f78:24281:1)
    at Object.findDOMNode (react-dom.development.js?5f78:24804:1)
    at Timeline.grid_ref_callback (timeline.js?0f63:965:46)

I can post a minimal reproducible example repo if you want.

junkkerrigan avatar Mar 28 '22 20:03 junkkerrigan

Hey, will take a look on the weekend. Pretty flat out at work but should have time then

lilfolr avatar Mar 30 '22 12:03 lilfolr