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

Documentation - Docs/Components/Selects/SelectPage.razor could use more detail #3207

Closed
SomeoneElseOSM opened this issue Dec 3, 2021 · 4 comments
Labels
Area: Documentation Something is missing in the documentation.

Comments

@SomeoneElseOSM
Copy link

SomeoneElseOSM commented Dec 3, 2021

There are a couple of issues with https://blazorise.com/docs/components/select/ :

  • A bit more detail throughout would be helpful
  • Specifically, highlight that the Blazorise component is <Select> not the (completely valid, but not Blazorise) <select>.

Blazor itself doesn't always react well to errors, but this isn't really a Blazor problem; when a component contains something that is valid ASP but makes no sense in Blazorise (misuse of Blazorise components, for example <select> instead of <Select> it can't be expected to say "you probably meant (completely legal but meaningful) thing B rather than (also completely legal but meaningless in Blazorise) thing A".

I'm happy to submit a pull request (adding a "Note" similar to the "Otherwise the Select will not behave as expected." one lower down) if desired.

@SomeoneElseOSM SomeoneElseOSM added the Type: Bug 🐞 Something isn't working label Dec 3, 2021
@stsrki
Copy link
Collaborator

stsrki commented Dec 3, 2021

I don't think this is wrong. We could add a note, it's not difficult to do so. But, the naming convention for Blazor components is that everything with an uppercase is a component, and everything with lowercase is an element. This is per ASP.NET documentation https://docs.microsoft.com/en-us/aspnet/core/blazor/components/?view=aspnetcore-6.0#names.

A similar pattern is for other SPA frameworks, so I would say it is somewhat a standard way of naming components.

@David-Moreira
Copy link
Contributor

I don't see a problem here either.. But a note can't hurt I guess. :)

@stsrki
Copy link
Collaborator

stsrki commented Dec 3, 2021

I agree, a note can be added to the docs.

@stsrki stsrki added Area: Documentation Something is missing in the documentation. and removed Type: Bug 🐞 Something isn't working labels Dec 3, 2021
@David-Moreira
Copy link
Contributor

@SomeoneElseOSM can you elaborate on this point?

  • A bit more detail throughout would be helpful

What kind of detail do you think we should add that would be more helpful in using this particular component?
Thanks!

@stsrki stsrki added this to the 0.9.5 Support milestone Dec 5, 2021
@stsrki stsrki closed this as completed Dec 5, 2021
@stsrki stsrki added this to Support Aug 3, 2024
@stsrki stsrki moved this to ✔ Done in Support Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Something is missing in the documentation.
Projects
Archived in project
Development

No branches or pull requests

3 participants