As a long-term user and recent contributor I can give you some answers and my point of view.
I don’t think that officially Aurelia UX is considered production ready even though I know it is already used in production. In my work projects we are definitely using it in production in several apps (desktop, mobile, PWA, cordova).
As you said, one of the biggest missing piece is documentation and proper showcase. The demo app inside the lib is a good start. I’m currently working on a PR with more exemples and some configuration tools.
What I’ve found is that once you start using the components it’s pretty straightforward to get how they work. Basically you need to look at the
@bindable to get the functional options and the properties in the theme files to get the styling options.
I am planning to continue contributing and enhance the documentation part. But to be honest it will probably take a few more weeks to get where I would like it to be.
Regarding the icons: YES you can use your own icon set. In this blog post you can find some exemples about the icons package.
Your icons need to be in
SVG and you will have to register your set(s) using one of the following format:
// array form
"person", // icon name
"<path d=\"M12 ...\"></path>", // svg path (without the svg tag)
24, // optional (viewport width, default to 24)
24 // optional (viewport height, default to 24)
// object form
"name": "person", // icon name
"svg": "<svg viewBox=\"0 0 24 24\"><path d=\"M12 ...\"></path></svg>" // svg path (with the svg tag)
On a personnal note: I think I was one of the early adopters of Aurelia UX when it came out. I really liked the approach of theming and the components written “The Aurelia way”. However it’s been a quite difficult ride (esp. the begninning with breaking changes and important missing pieces). A few times I thought about giving up on it, but I always had the feeling that Aurelia UX had the potential and was not too far away from production-ready. It has pushed me to start contributing and I’ve found this experience very interesting and rewarding.
It’s not the more complete UX lib out there. It will definitely depends on your requirements. But it has strong benefits and has room for improvements and creative ideas.