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

There is an official documentation? #12

Open
DevTony101 opened this issue Oct 8, 2019 · 6 comments
Open

There is an official documentation? #12

DevTony101 opened this issue Oct 8, 2019 · 6 comments
Labels

Comments

@DevTony101
Copy link

Although I know the basics of bootstrap for web development, is hard to know how to properly add classes to a jfx element. It would be a lot easier if there was a documentation page.

@aalmiray
Copy link
Collaborator

aalmiray commented Oct 8, 2019

The README contains everything that there is to know about this Project. There's even an example setting a style on a Button. Is there anything else that's missing?

@DevTony101
Copy link
Author

Yes, indeed, the README is very helpful and it shows everything the project currently supports, but it lacks code examples.

@aalmiray
Copy link
Collaborator

aalmiray commented Oct 9, 2019

The current example is minimalistic in nature as its purpose is to show

  1. How the stylesheet may be applied.
  2. How a style class may be applied to a graphical element.

Everything in that snippet is regular JavaFX code BootstrapFX is just CSS at the moment (well except for a custom Pane class shown in the demo), there’s no additional API.

What more examples would be needed?

@DevTony101
Copy link
Author

I was hoping there was at least one code example per graphical component (that is, one for buttons, split-buttons, label, alerts, etc) but then again, it is only a suggestion, the code example shown in the README is perfectly understandable.

@aalmiray
Copy link
Collaborator

aalmiray commented Oct 9, 2019

Perhaps if every usage as you suggest were to be accompanied by a screenshot. However the snippets of code would quickly be repetitive.

@DevTony101
Copy link
Author

I agree, but it would be very helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants