@octopusdeploy/design-system-components/dist/src/routing/PageTitleProvider.js

The design systems component library.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.PageTitleProvider = PageTitleProvider;
exports.useSetPageTitlePrimarySegmentEffect = useSetPageTitlePrimarySegmentEffect;
exports.useSetPageTitleSecondarySegmentEffect = useSetPageTitleSecondarySegmentEffect;
exports.usePageTitleFromPageHeaders = usePageTitleFromPageHeaders;
const jsx_runtime_1 = require("react/jsx-runtime");
const react_1 = __importStar(require("react"));
const PageTitleSettersContext = react_1.default.createContext(undefined);
function PageTitleProvider({ children }) {
    const [primarySegment, setPrimarySegment] = (0, react_1.useState)(undefined);
    const [secondarySegment, setSecondarySegment] = (0, react_1.useState)(undefined);
    usePageTitleFromPageHeaders(primarySegment, secondarySegment);
    const pageTitleSetters = (0, react_1.useMemo)(() => ({
        setPrimarySegment,
        setSecondarySegment,
    }), []);
    return (0, jsx_runtime_1.jsx)(PageTitleSettersContext.Provider, { value: pageTitleSetters, children: children });
}
function usePageTitleSetters() {
    const contextValue = react_1.default.useContext(PageTitleSettersContext);
    if (contextValue === undefined) {
        throw new Error("PageTitleSetters context value has not been provided via a PageTitleProvider");
    }
    return contextValue;
}
function useSetPageTitlePrimarySegmentEffect(title) {
    const { setPrimarySegment } = usePageTitleSetters();
    (0, react_1.useEffect)(() => {
        setPrimarySegment(title);
        return () => {
            setPrimarySegment(undefined);
        };
    }, [setPrimarySegment, title]);
}
function useSetPageTitleSecondarySegmentEffect(title) {
    const { setSecondarySegment } = usePageTitleSetters();
    (0, react_1.useEffect)(() => {
        setSecondarySegment(title);
        return () => {
            setSecondarySegment(undefined);
        };
    }, [setSecondarySegment, title]);
}
function usePageTitleFromPageHeaders(primarySegment, secondarySegment) {
    (0, react_1.useEffect)(() => {
        const segments = [primarySegment, secondarySegment, "Octopus Deploy"].filter((value) => value !== undefined && value !== StringHelper.ellipsis);
        const pageTitle = segments.join(" - ");
        document.title = pageTitle;
    }, [primarySegment, secondarySegment]);
}
// This matches the StringHelper.ellipsis from Portal
const StringHelper = {
    ellipsis: "...",
};