@anywhere-ui/core
TypeScript icon, indicating that this package has built-in type declarations

0.3.0 • Public • Published

Welcome to @anywhere-ui/core 👋

Version Documentation Maintenance NPM

AnywhereUi is a library of rich WEB Components.

Install

npm install @anywhere-ui/core

Features

  • Tiny, highly optimized components built with Stencil
  • No build or compiling required
  • Simply add the static files to any project
  • Lazy-loaded components without configuration
  • Asynchronous rendering
  • Theming through CSS Variables

Usage

JavaScript

Integrating a anywhere-ui component to a project without a JavaScript framework is straight forward. If you're using a simple HTML page, you can add your component via a script tag. For example, if we published a component to npm, we could load the component through a CDN like this:

<html>
  <head>
    <script src="https://unpkg.com/@anywhere-ui/core@latest/dist/anywhere-ui/anywhere-ui.js"></script>
    <link
      href="https://unpkg.com/@anywhere-ui/core@latest/dist/anywhere-ui/anywhere-ui.css"
      rel="stylesheet"
    />
  </head>
  <body>
    <any-checkbox></any-checkbox>
  </body>
</html>

Alternatively, if you wanted to take advantage of ES Modules, you could include the components using an import statement. Note that type="module" only works in modern browsers (not available in IE11 or Edge 12-18).

<html>
  <head>
    <script type="module">
      import { defineCustomElements } from "https://unpkg.com/@anywhere-ui/core@latest/loader";
      defineCustomElements();
    </script>
    <link
      href="https://unpkg.com/@anywhere-ui/core@latest/dist/anywhere-ui/anywhere-ui.css"
      rel="stylesheet"
    />
  </head>
  <body>
    <any-checkbox></any-checkbox>
  </body>
</html>

Framework Bindings

The @anywhere-ui/core package can by used in simple HTML, or by vanilla JavaScript without any framework at all. AnywhereUI also has packages that make it easier to integrate AnywhereUI into a framework's traditional ecosystem and patterns. (However, at the lowest-level framework bindings are still just using AnywhereUI Core and Web Components).

Author

👤 Goran Jovanović

Contribute

If you would like to contribute, you are welcome. Clone repository and open pull request.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Adaleks Technology.
This project is MIT licensed.

Package Sidebar

Install

npm i @anywhere-ui/core

Weekly Downloads

80

Version

0.3.0

License

MIT

Unpacked Size

4.11 MB

Total Files

248

Last publish

Collaborators

  • gjovanovicst