Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/Make documentation #251

Open
lilfolr opened this issue Feb 7, 2022 · 2 comments
Open

Update/Make documentation #251

lilfolr opened this issue Feb 7, 2022 · 2 comments
Labels
feature New feature or request

Comments

@lilfolr
Copy link
Collaborator

lilfolr commented Feb 7, 2022

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 lilfolr added the feature New feature or request label Feb 7, 2022
@lilfolr lilfolr moved this to Backlog in ReactTimeline9K Feb 7, 2022
@lilfolr lilfolr moved this from Backlog to Todo in ReactTimeline9K Feb 7, 2022
@junkkerrigan
Copy link

junkkerrigan commented Mar 28, 2022

@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 #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.

@lilfolr
Copy link
Collaborator Author

lilfolr commented Mar 30, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
Status: Todo
Development

No branches or pull requests

2 participants