Coder Social home page Coder Social logo

gndz07 / traefiklabs-hub-button-app Goto Github PK

View Code? Open in Web Editor NEW

This project forked from traefik/traefiklabs-hub-button-app

0.0 0.0 0.0 425 KB

Traefik Hub Button with WebComponents

Home Page: https://hub.traefik.io

License: MIT License

JavaScript 0.52% TypeScript 48.12% Makefile 3.50% HTML 47.86%

traefiklabs-hub-button-app's Introduction

Traefik Hub Button with WebComponents

This Project aims to solve the issue to have a Hub buttonin the Traefik dashboard.

WebComponents are a way to define a custom component that runs as any other HTML component, so it can be used in any framework or even in pure HTML files, after importing the JS file with the component definition.

For this project, it was used a React version of the Header, encapsulated in a custom component called "hub-button-app".

Any future changes in the header must be done in this Repo, and should be automatically propagated to all pages that uses it.

How to test

  • Clone the project
  • yarn install
  • yarn start

Check the page that opens if the Header is properly rendered and if the latest post has been fetched.

How to build

  • yarn install
  • yarn build

It will create a build folder with the compiled assets.

How to use

Put the full URL of the script file in the src attribute of a <script> tag:

<script src="https://traefik.github.io/traefiklabs-hub-button-app/main-v1.js"></script>

You can place the script reference in head or body tag, as you like.

Then, you can use the hub-button-app custom element wherever you need it. Please notice the custom element exposes a property called theme to control its appearance; possible values can be dark or light, with light as the default value.

Embed into another project (local fallback)

The script (and its sourcemap) can be embedded in another project codebase, this can be useful as a local fallback in case the remote source became unavailable.

To make the static assets on your computer please run make static-assets.

Please notice that in macOS '' must be added after -i in each sed command, e.g. sed -i 's@something@something@' dest.file become sed -i '' 's@something@something@' dest.file.

When you have the static assets available please remember to update, in both the script and its sourcemap, the following lines:

File Line Key
main-v1.js 3 sourceMappingURL
main-v1.js.map 1 file

Deployment URLs

traefiklabs-hub-button-app's People

Contributors

mdeliatf avatar mmatur avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.