@finos/legend-lego/lib/application/DocumentationLink.js

Legend code editor support

import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { shouldDisplayVirtualAssistantDocumentationEntry, useApplicationStore, } from '@finos/legend-application';
import { clsx, QuestionCircleIcon } from '@finos/legend-art';
export const DocumentationLink = ({ documentationKey, title, className, inline = true }) => {
    const applicationStore = useApplicationStore();
    const documentationEntry = applicationStore.documentationService.getDocEntry(documentationKey);
    const openDocLink = (event) => {
        event.preventDefault();
        event.stopPropagation();
        applicationStore.assistantService.openDocumentationEntryLink(documentationKey);
    };
    if (!documentationEntry ||
        (!documentationEntry.url &&
            !shouldDisplayVirtualAssistantDocumentationEntry(documentationEntry))) {
        return null;
    }
    return (_jsx("div", { onClick: openDocLink, title: title ?? 'Click to see documentation', className: clsx('documentation-link', className, {
            'documentation-link--inline': inline,
        }), children: _jsx(QuestionCircleIcon, {}) }));
};
export const DocumentationPreview = (props) => {
    const { documentationKey, text, className } = props;
    const applicationStore = useApplicationStore();
    const documentationEntry = applicationStore.documentationService.getDocEntry(documentationKey);
    const textContent = text ?? documentationEntry?.text;
    if (!textContent) {
        return null;
    }
    return (_jsxs("div", { className: clsx('documentation-preview', className), children: [_jsx("div", { className: "documentation-preview__text", children: textContent }), _jsx("div", { className: "documentation-preview__hint", children: documentationEntry && (_jsx(DocumentationLink, { documentationKey: documentationKey })) })] }));
};
//# sourceMappingURL=DocumentationLink.js.map