GithubHelp home page GithubHelp logo

SahnaS Web Widget

This is a reference project that demonstrate how to build web UI widget that can be embedded into 3rd party website.

This structure provides those advantages:

  • Small footprint and solid snippet on hosting website (see Usage)
  • Multi-instance on the same page
  • Isolation of code execution and CSS
  • Customization via configuration injection and API to Widget
  • Minimal dependencies and small size via single request (>30KB gzipped)

and a few more.

Usage

In order to embed the widget add the following snippet at any location on the hosting page:

<script>
    (function (w, d, s, o, f, js, fjs) {
        w[o] = w[o] || function () { (w[o].q = w[o].q || []).push(arguments) };
        js = d.createElement(s), fjs = d.getElementsByTagName(s)[0];
        js.id = o; js.src = f; js.async = 1; fjs.parentNode.insertBefore(js, fjs);
    }(window, document, 'script', 'sahnas', 'https://www.comexposium.com/sahnas.min.js'));
    sahnas('init');
</script>

During initialization you can pass additional configurations to widget like so:

sahnas('init', { minimized: false, disableDarkMode: false, styles: { classNameContainer: "sahnas" } });

You can find a full list of configurations in AppConfigurations interface:

{
    debug: boolean;
    serviceBaseUrl: string;
    minimized: boolean;
    disableDarkMode: boolean;
    text: {
        minimizedTitle?: string;
        formTitle?: string;
        formSubTitle?: string;
        thankYouTitle?: string;
        thankYouBody?: string;
        faqTitle?: string;
    };
    styles: {
        classNameContainer?: string;
    };
}

Develop

The widget dev setup is similar to regular client application. To get started:

npm i
npm start
npm run go

This will open browser with a demo page which hosts the widget. The npm run go command is the same command as npm start but it will run the dev server on port 9000.

License

The source and documentation in this project are released under the MIT License

SahnaS's Projects

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.