Theme utils

Knowbly theme utils

Usage

import themeUtils, { themeClasses, themeData, scopeCss, mapThemeSettings, upTo, generateButtonCSS, getSettingsDefaultVars, transformLockVars } from "@knowbly/theme-utils";
// const themeUtils = require("@knowbly/theme-utils").default;
// const { themeClasses, themeData, scopeCss, mapThemeSettings, upTo, generateButtonCSS, getSettingsDefaultVars, transformLockVars } = require("@knowbly/theme-utils");

console.log(themeUtils);
// output
// {
//     getFontSizeElements: [Function: getFontSizeElements],
//     transformColor: [Function: transformColor],
//     needsUnit: [Function: needsUnit],
//     hasUnit: [Function: hasUnit],
//     transformValue: [Function: transformValue],
//     isColorType: [Function: isColorType],
//     getSettingValue: [Function: getSettingValue],
//     transformSettingVars: [Function: transformSettingVars],
// }

Development

You must run npm link in this repository and then in other projects run npm link @knowbly/theme-utils to see your changes. Changes should be merged mostly into the dev brach.

Publish to npm steps

Create a new branch from dev (or the corresponding feature branch) and run the next commands:

# build production bundle, tests must pass
$ npm run build
# npx webpack --config webpack.config.js --mode=production --json > dist/stats.json
# npx jest

# update package.json version
$ npm version patch

# publish to knowbly org
$ npm publish --access public

Note: you need to commit build changes before running npm version patch.

Then in widget-composer update package.json to the published version.

Feature flags

There are some feature flags that uses different releases from this package. They should be developed in their own branch. Check dev-feature/audio-narration to see an example. They have to be published as special dependencies with the command npm version patch --no-git-tag-version.

If the sprint changed, then you need to update the version of @knowbly/theme-utils (package.json) in:

• https://github.com/Knowbly/knowbly-export-service
• https://github.com/Knowbly/system-admin-sdk
• https://github.com/Knowbly/widget-composer-sdk
• https://github.com/Knowbly/widget-composer
• https://github.com/Knowbly/widget-sandbox
• https://github.com/Knowbly/knowbly-widget-components