-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
report-renderer.d.ts
32 lines (27 loc) · 1.64 KB
/
report-renderer.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
/**
* @license Copyright 2021 The Lighthouse Authors. All Rights Reserved.
* 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 { Result as AuditResult } from "../../types/lhr/audit-result";
declare module Renderer {
function renderReport(lhr: AuditResult, options?: Options): HTMLElement;
interface Options {
/**
* Don't automatically apply dark-mode to dark based on (prefers-color-scheme: dark). (DevTools and PSI don't want this.)
* Also, the fireworks easter-egg will want to flip to dark, so this setting will also disable chance of fireworks. */
disableAutoDarkModeAndFireworks?: boolean;
/** Disable the topbar UI component */
omitTopbar?: boolean;
/** Prevent injection of report styles. Set to true if these styles are already included by the environment. */
omitGlobalStyles?: boolean;
/**
* Convert report anchor links to a different format.
* Flow report uses this to convert `#seo` to `#index=0&anchor=seo`.
*/
onPageAnchorRendered?: (link: HTMLAnchorElement) => void;
/** If defined, `Save as HTML` option is shown in dropdown menu. */
getStandaloneReportHTML?: () => string;
}
}
export default Renderer;