[docs] Add more examples

[martinszeltins]

Reproduction

⠀

Steps to reproduce the bug

Add more useful examples to the docs.

- DONE -
[x] Custom Rules
[x] Conditional Rules
[x] Collections
[x] Server Validation
[x] Required Indicators

- TO DO -
[ ] Nested Forms
    Deeply nested forms, arrays, how to access parent items in each rule etc.
[ ] Multi-component Forms
    This will be a very popular example, to showcase how to use Pinia store
    and multiple components for a form. Also could demonstrate how to pass props to components.
[ ] Custom Metadata
    How to add custom metadata info to fields
[ ] Advanced Example

Expected behavior

⠀

Actual behavior

⠀

Environnement informations

No response

[victorgarciaesgi]

Yep all of your list is planned for the advanced example 👍

[martinszeltins]

Yep all of your list is planned for the advanced example 👍

I think it'd be a good idea to also have separate examples listed as users may not know that they are included inside the advanced-example.

[victorgarciaesgi]

Yep agree! The advanced is more to show a more real world example on how to structure your logic around Pinia, Components, props etc..!

[martinszeltins]

I think this isn't completed yet, we still have these examples to add later. But this could be done after 1.0

- TO DO -
[ ] Nested Forms
    Deeply nested forms, arrays, how to access parent items in each rule etc.
[ ] Multi-component Forms
    This will be a very popular example, to showcase how to use Pinia store
    and multiple components for a form. Also could demonstrate how to pass props to components.
[ ] Custom Metadata
    How to add custom metadata info to fields
[ ] Advanced Example

[genu]

Are Multi-component Forms currently possible, or schema composition?

[victorgarciaesgi]

Yes it's already possible! https://reglejs.dev/typescript/typing-props

[genu]

Yes it's already possible! https://reglejs.dev/typescript/typing-props

Hmm, thanks for pointing me there.

I'm still not exactly sure how to work with the state when it is spread across components, for example. For example:

I'm testing regle in an OS project here: https://github.com/genu/team-generator/pull/268/files#diff-12ebdf3416745f58aa6c74198855590abd67f26937ed199ab7c8295f0077c47c

Is this the proper way to work with a sub type for players and EditPlayerForm?

[chrisnruud]

Additionally, since Quasar list Regle specifically as the library to use with external validation, some best practices for those of us that use Quasar would be immensly appreciated. As of now, I am just porting any vee-validate + quasar patterns I come across and I am not sure whether that is the most effective way.

[victorgarciaesgi]

To be honest they declared it without me knowing it 😂 But it's so cool to be recognized by them.

I don't know much about quasar, I will deep dive into it. And maybe create a @regle/quasar package.

Is there similar module features between Nuxt and Quasar?

[udrzbarik]

Hi! If this is still an issue, I'll gladly work on some examples whenever I have time, just let me know what I could help with!

[martinszeltins]

Hi! If this is still an issue, I'll gladly work on some examples whenever I have time, just let me know what I could help with!

I think examples are always welcome, it really helps users to get started quickly and understand how to use it.

[victorgarciaesgi]

Yeah more exemples are always welcome!

You can create a PR here https://github.com/victorgarciaesgi/regle-examples (Couldn't use the main repo as Stackblitz doesn't support pnpm catalogs :(

Use any style library you want (tailwind etc)

And then create a PR in the regle repo that add the links in the docs 👍