go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/analysis/frontend/ui/src/components/sanitized_html/sanitized_html.tsx (about)

     1  // Copyright 2023 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  import { Box, SxProps, Theme } from '@mui/material';
    16  import { useMemo } from 'react';
    17  
    18  import { sanitizeHTML } from './sanitize_html/sanitize_html';
    19  
    20  export interface SanitizedHtmlProps {
    21    /**
    22     * The HTML TO BE SANITIZED and rendered.
    23     */
    24    readonly html: string;
    25    readonly sx?: SxProps<Theme>;
    26    readonly className?: string;
    27  }
    28  
    29  /**
    30   * Sanitize & render the HTML into a <Box />.
    31   * @return {JSX.Element} the Box.
    32   */
    33  export function SanitizedHtml({ html, sx, className }: SanitizedHtmlProps) {
    34    // `sanitizedHtml` must be a `TrustedHTML` not a `string` to ensure the HTML
    35    // doesn't get sanitized again by the default trusted type policy.
    36    //
    37    // Declare the type explicitly to detect breakage in the future.
    38    const sanitizedHtml: string = useMemo(
    39        () => sanitizeHTML(html),
    40        [html],
    41    );
    42  
    43    return (
    44      <Box
    45        sx={sx}
    46        className={className}
    47        // We've sanitized the HTML.
    48        // eslint-disable-next-line react/no-danger
    49        dangerouslySetInnerHTML={{
    50          __html: sanitizedHtml,
    51        }}
    52      />
    53    );
    54  }