@atlaskit/app-provider
Version:
A top level provider for the Design System.
40 lines (39 loc) • 2.18 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
exports.getScrollbarHarmonisationHtmlAttrs = getScrollbarHarmonisationHtmlAttrs;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
var _fg = require("@atlaskit/platform-feature-flags/fg");
var _constants = require("./constants");
/**
* Server-side rendering utility. Generates the harmonised scrollbar HTML attributes so a
* product's server can spread them onto the server-rendered `<html>` element. This avoids the
* flash of un-harmonised scrollbars that would otherwise occur while waiting for
* `useScrollbarHarmonisation`'s client-only effect to run.
*
* @param input - A boolean overrides the base appearance, while transparency still requires
* both shared gates. When omitted, the shared gates control the appearance. An object supplies
* both product-resolved gate results without evaluating shared gates; transparency requires
* `isEnabled` and `isTransparentEnabled` to both be true.
*
* @returns {Object} Object of HTML attributes to be applied to the document root
*/
function getScrollbarHarmonisationHtmlAttrs(input) {
var resolvedGates = (0, _typeof2.default)(input) === 'object' && input !== null ? input : undefined;
var isGateEnabled = resolvedGates ? resolvedGates.isEnabled : (0, _fg.fg)('platform_dst_scrollbar_harmonisation');
var shouldEnable = typeof input === 'boolean' ? input : isGateEnabled;
if (!shouldEnable) {
return {};
}
var result = (0, _defineProperty2.default)({}, _constants.SCROLLBAR_HARMONISATION_ATTRIBUTE, '');
var isTransparentTrackGateEnabled = resolvedGates ? resolvedGates.isTransparentEnabled : (0, _fg.fg)('platform_dst_scrollbar_harmonisation_transparent');
if (isGateEnabled && isTransparentTrackGateEnabled) {
result[_constants.SCROLLBAR_HARMONISATION_TRANSPARENT_ATTRIBUTE] = '';
}
return result;
}
var _default = exports.default = getScrollbarHarmonisationHtmlAttrs;