bootstrapfx icon indicating copy to clipboard operation
bootstrapfx copied to clipboard

There is an official documentation?

Open DevTony101 opened this issue 5 years ago • 6 comments

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.

DevTony101 avatar Oct 08 '19 18:10 DevTony101

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?

aalmiray avatar Oct 08 '19 19:10 aalmiray

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

DevTony101 avatar Oct 08 '19 21:10 DevTony101

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?

aalmiray avatar Oct 09 '19 00:10 aalmiray

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.

DevTony101 avatar Oct 09 '19 03:10 DevTony101

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

aalmiray avatar Oct 09 '19 06:10 aalmiray

I agree, but it would be very helpful.

DevTony101 avatar Oct 09 '19 20:10 DevTony101