keycloak_theme/README.md
2021-02-20 10:53:26 +00:00

1.7 KiB

Provides a way to customise Keycloak login and register pages with React

Home - Documentation

Install / Import

$ npm install --save keycloak-react-theming
import { myFunction, myObject } from "keycloak-react-theming";

Specific imports:

import { myFunction } from "keycloak-react-theming/myFunction";
import { myObject } from "keycloak-react-theming/myObject";

Import from HTML, with CDN

Import it via a bundle that creates a global ( wider browser support ):

<script src="//unpkg.com/keycloak-react-theming/bundle.min.js"></script>
<script>
    const { myFunction, myObject } = keycloak_react_theming;
</script>

Or import it as an ES module:

<script type="module">
    import {
        myFunction,
        myObject,
    } from "//unpkg.com/keycloak-react-theming/zz_esm/index.js";
</script>

You can specify the version you wish to import: unpkg.com

Contribute

npm install
npm run build
npm test