couds / react-bulma-components

React components for Bulma framework
MIT License
1.21k stars 126 forks source link

Component documentation #68

Closed multimeric closed 6 years ago

multimeric commented 6 years ago

Hi, I found it very confusing as a new user of the library, because many of the components are namespaced but not others.

For example, to access the Button component, you can import it directly

import { Button } from 'react-bulma-components/full'

<Button>

But to access the Input component, you need to go into the Form object:

import { Form } from 'react-bulma-components/full'

<Form.Input/>

However this isn't documented anywhere! Am I missing something obvious here?

couds commented 6 years ago

Hi @TMiguelT Thanks for using this library

-sorry about the documentation, right now the only real documentation are the storybbok. but the current version storybook its not good enough, Im working on the v2.0.0 (right now you can start using the prerelease version with npm i react-bulma-components@next) to improve the storybook to add the correct code examples like this.

image

I'm doing some testing I trying to release this version maybe the next week.

PD: The components that are exported directly from the root module are the ones listed on the readme (the same components that are listed on the storybook, this should be documented somewhere)

Thanks!

multimeric commented 6 years ago

Ah great, if the storybook includes code examples it would be very helpful!

couds commented 6 years ago

Hi @TMiguelT I just release the v2 of the library. I hope that with the new storybook the library will be easier to use.

PD. I'm closing this issue, if you have any issue do not hesitate to open a new issue =)

chenshuiluke commented 6 years ago

@couds Sweet 😄