@social-embed/wc
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.4-next.0 • Public • Published

    <o-embed> · GitHub license npm version

    A modern, TypeScript web component for OEmbed tags. Built in LitElement.

    At this stage: This doesn't actually use OEmbed, rather it finds IDs and swaps out with an embed template. It's created for use with CKEditor 5, see ckeditor5#2737.

    Demo: CodeSandbox, Examples: YouTube, Spotify, Vimeo, DailyMotion

    Compare to thangman22/oembed-component.

    Setup

    Install dependencies:

    npm i @social-embed/wc
    yarn add @social-embed/wc

    Usage

    <o-embed src="https://www.youtube.com/watch?v=G_QhTdzWBJk"></o-embed>

    Contributing

    Build

    This sample uses the TypeScript compiler to produce JavaScript that runs in modern browsers.

    To build the JavaScript version of your component:

    npm run build

    To watch files and rebuild when the files are modified, run the following command in a separate shell:

    npm run build:watch

    Both the TypeScript compiler and lit-analyzer are configured to be very strict. You may want to change tsconfig.json to make them less strict.

    Testing

    This sample uses web-test-runner and the open-wc test helpers for testing. See the open-wc testing documentation for more information.

    Tests can be run with the test script:

    npm test

    Dev Server

    This sample uses open-wc's es-dev-server for previewing the project without additional build steps. ES dev server handles resolving Node-style "bare" import specifiers, which aren't supported in browsers. It also automatically transpiles JavaScript and adds polyfills to support older browsers.

    To run the dev server and open the project in a new browser tab:

    npm run serve

    There is a development HTML file located at /dev/index.html that you can view at http://localhost:8000/dev/index.html.

    Editing

    If you use VS Code, we highly reccomend the lit-plugin extension, which enables some extremely useful features for lit-html templates:

    • Syntax highlighting
    • Type-checking
    • Code completion
    • Hover-over docs
    • Jump to definition
    • Linting
    • Quick Fixes

    The project is setup to reccomend lit-plugin to VS Code users if they don't already have it installed.

    Linting

    Linting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.

    The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json and tsconfig.json.

    To lint the project run:

    npm run lint

    Formatting

    Prettier is used for code formatting. It has been pre-configured according to the Polymer Project's style. You can change this in .prettierrc.json.

    Prettier has not been configured to run when commiting files, but this can be added with Husky and and pretty-quick. See the prettier.io site for instructions.

    Static Site

    This project includes a simple website generated with the eleventy static site generator and the templates and pages in /docs-src. The site is generated to /docs and intended to be checked in so that GitHub pages can serve the site from /docs on the master branch.

    To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".

    To build the site, run:

    npm run docs

    To serve the site locally, run:

    npm run docs:serve

    To watch the site files, and re-build automatically, run:

    npm run docs:watch

    The site will usually be served at http://localhost:8000.

    Bundling and minification

    This starter project doesn't include any build-time optimizations like bundling or minification. We recommend publishing components as unoptimized JavaScript modules, and performing build-time optimizations at the application level. This gives build tools the best chance to deduplicate code, remove dead code, and so on.

    For information on building application projects that include LitElement components, see Build for production on the LitElement site.

    More information

    See Get started on the LitElement site for more information.

    Credit

    lit-element-starter-ts

    Install

    npm i @social-embed/wc

    DownloadsWeekly Downloads

    484

    Version

    0.0.4-next.0

    License

    MIT

    Unpacked Size

    57.1 kB

    Total Files

    26

    Last publish

    Collaborators

    • tony