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

[portal tag] proposal to enable portal of element / text #8287

Closed
yinonov opened this issue Sep 15, 2022 · 1 comment
Closed

[portal tag] proposal to enable portal of element / text #8287

yinonov opened this issue Sep 15, 2022 · 1 comment

Comments

@yinonov
Copy link

yinonov commented Sep 15, 2022

A common practice to quote in the web is utilizing the blockquote and cite tags to present context as a quoted source.

When authoring articles, documentation in particular, there's often a need to refer a proxy or mutual member to a source from sub sections.

Best experience for a reader would be to read the context on the spot while knowing it is a portal to a different existing live source.

Let's say we document a popup element class that is integrated within a menu (menu uses popup under its hood).
when authoring a doc for each will first describe the source (popup)

<h1>Popup</h1>

<h2>Open</h2>

<p>use the `open` attribute to set the popup open state.</p>

<ul>
  <li>Type: boolean</li>
  <li>Default: false</li>
</ul>

then in menu we will need to either:

  • reference - link to the popup page source. tedious for user and breaks the reading flow
<h1>Popup</h1>

<h2>Open</h2>

<p>Delegates to the [open property in the underlying popup element](https://vivid.deno.dev/popup#open).</p>

<ul>
  <li>Type: boolean</li>
  <li>Default: false</li>
</ul>
  • hardcode - repeat the same description (copy & paste). Requires maintenance and can be forgotten over time
<h1>Menu</h1>

<h2>Open</h2>

<p>use the `open` attribute to set the popup open state.</p>

<ul>
  <li>Type: boolean</li>
  <li>Default: false</li>
</ul>

A better experience for a reader would be to reflect the fact that the sub section is referring to a source
GitHub are already featuring such a behavior by embedding permalinks

We are committed to providing a friendly, safe and welcoming environment for all. Please read and respect the [WHATWG Code of Conduct](https://whatwg.org/code-of-conduct).

we should be able to portal a window of specific area of html or text

@yinonov
Copy link
Author

yinonov commented Oct 6, 2022

apparently this is also addressed at #6507

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants