Version indicator for rendered examples
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- react
- Ambito
- documentation
Direzione di ricerca
Inizia confrontando gli URL degli esempi collegati di Date Time Picker Lit, React e Flow con l'esempio incorporato, il selettore „Show code“ e l'azione „Open in a new tab“. Il lavoro è completato quando gli utenti possono identificare la versione visualizzata negli esempi incorporato e aperto, capire quando differisce dalla loro selezione e vedere quali versioni sono disponibili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
#4400 changed the Docs to always render the React example if available, regardless of the selected source code type. This causes some issues.
- Currently it isn't indicated to the users in any way that the rendered example doesn't match the source code selection.
- You can still view e.g. the Flow example by clicking the "Open in a new tab" button at the corner when you have Flow selected for displaying the source code, but it likewise isn't indicated in any way that this is necessary, or that it possibly opens something else than what you already see.
- If you do open to a new tab, what you see there doesn't indicate which version it belongs to either, or whether it matches what you saw in the embedded version. You can't easily decipher this from the new URL either.
- You can't even see the version selection without first clicking 'Show code', so you might be initially looking at an embedded React example and accidentally open a Lit example to a new tab when you are actually trying to check out how the feature behaves in Flow.
- Presumably if one of these versions didn't exist at all, it would open some other version in the new tab without the user being none the wiser.
E.g. the first example about Date Time Picker component currently links to these pages: Lit, React, Flow
The Lit URL above doesn't even mention Lit, and the Flow URL doesn't mention Flow but it does mention React even if it's apparently still the Flow example in reality.
Obviously none of this is very ideal and it's confusing to users and staff members both.
-
It would be nice to have some small indicator in the embedded example already on what version is rendered there -- if I understood correctly it's not even always React, it might still be Lit or Flow of there is no React version available. This indicator could be e.g. an icon or a letter.
- Bonus points if there would be an info button or a tooltip or something else that explains what the indicator means -- and, if that's indeed the case, why the displayed version doesn't match the selected version in the code examples. If this explanation is very long, it could link to some FAQ instead.
-
It would also be nice to have some small indicator in the opened tab on which version was actually opened there.
- Bonus points if the indicator could be clickable to expand a version list that would indicate which other versions are actually available and redirect you there upon selection.
If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.
- Lingua principale
- AsciiDoc
- Stelle
- 38
- Fork
- 225
- Merge medio
- 17h 38m
- PR unite (30g)
- 214
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di vaadin/docs
-
Creating Tests page uses deprecated TestBench ElementQuery APIForse già presa @jcgueriaud1 l’ha presa 5 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 1 giorno
-
design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
vaadin/docs#5773 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
design system
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
a11y design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
a11y design system
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
OneBusAway/maglev#2145 ·
I maintainer di solito rispondono entro 2 giorni
-
ada documentation mobile report
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
physicsdolphin/nv-uefi-unlocker#254 · 2 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
devops help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
guaardvark/guaardvark#421 ·
I maintainer di solito rispondono entro 2 giorni
-
marketing
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Add SECURITY.mdApertaenhancement
Difficoltà 1/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 1 giorno