Skip to content

Link to examples, if available #5

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

Merged
merged 1 commit into from
Mar 12, 2021
Merged

Link to examples, if available #5

merged 1 commit into from
Mar 12, 2021

Conversation

simonw
Copy link
Contributor

@simonw simonw commented Mar 12, 2021

When I'm researching a new web component the first thing I look for is a live example.

It looks like the GitHub repositories currently tagged with custom-element all use the homepage field to link to their examples.

This change exposes those examples in the README.

Repos tagged custom-element use the homepage field to link to their examples. Expose those in this README.
@simonw
Copy link
Contributor Author

simonw commented Mar 12, 2021

Here's the README.md generated by node generate.js using this patch:

github-elements

GitHub's Web Component collection.

We have 16 open source custom elements:

github/auto-check-element

An input element that validates its value with a server endpoint.

Repository | Example

github/auto-complete-element

Auto-complete input values from server search results.

Repository | Example

github/clipboard-copy-element

Copy element text content or input values to the clipboard.

Repository | Example

github/details-dialog-element

A modal dialog that's opened with <details>.

Repository | Example

github/details-menu-element

A menu opened with <details>.

Repository | Example

github/file-attachment-element

Attach files via drag and drop or file input.

Repository | Example

github/filter-input-element

Display elements in a subtree that match filter input text.

Repository | Example

github/g-emoji-element

Backports native emoji characters to browsers that don't support them by replacing the characters with fallback images.

Repository | Example

github/image-crop-element

A custom element for cropping a square image. Returns x, y, width, and height.

Repository | Example

github/include-fragment-element

A client-side includes tag.

Repository | Example

github/markdown-toolbar-element

Markdown formatting buttons for text inputs.

Repository | Example

github/remote-input-element

An input element that sends its value to a server endpoint and renders the response body.

Repository | Example

github/tab-container-element

An accessible tab container element with keyboard support.

Repository | Example

github/task-lists-element

Drag and drop task list items.

Repository | Example

github/text-expander-element

Activates a suggestion menu to expand text snippets as you type.

Repository | Example

github/time-elements

Web component extensions to the standard <time> element.

Repository

@simonw simonw changed the title Link to example, if available Link to examples, if available Mar 12, 2021
Copy link
Contributor

@koddsson koddsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you!

@koddsson koddsson merged commit 25b207c into github:main Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants