GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 08:01:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

storyshots-puppeteer: add browserLaunchOptions to documentation

Browse Source
This commit is contained in:
Will Dickinson 2022-08-12 13:09:49 -06:00
parent 3d89002300
commit f455ec17eb
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
code/addons/storyshots/storyshots-puppeteer/README.md
View File

@ -107,6 +107,26 @@ initStoryshots({
});
```
### Customizing browser launch options (Puppeteer API)
You might use the `browserLaunchOptions` to specify options for the default browser instance. Will be passed to [puppeteer.launch()](https://pptr.dev/api/puppeteer.puppeteernode.launch)
```js
import initStoryshots from '@storybook/addon-storyshots';
import { puppeteerTest } from '@storybook/addon-storyshots-puppeteer';
initStoryshots({
suite: 'Puppeteer storyshots',
test: puppeteerTest({
storybookUrl: 'https://some-local-ssl-url:7777',
browserLaunchOptions: {
// For ignoring self-signed certificates
ignoreHTTPSErrors: true,
},
}),
});
```
### Specifying custom Chrome executable path (Puppeteer API)
You might use `chromeExecutablePath` to specify the path to a different version of Chrome, without downloading Chromium. Will be passed to [Runs a bundled version of Chromium](https://github.com/GoogleChrome/puppeteer#default-runtime-settings)

4
code/addons/storyshots/storyshots-puppeteer/src/config.ts
View File

@ -32,6 +32,10 @@ export interface CommonConfig {
getGotoOptions: (options: Options) => DirectNavigationOptions;
customizePage: (page: Page) => Promise<void>;
getCustomBrowser: () => Promise<Browser>;
/**
* Puppeteer browser launch options:
* {@link https://pptr.dev/api/puppeteer.puppeteernode.launch/ puppeteer.launch()}
*/
browserLaunchOptions: LaunchOptions;
setupTimeout: number;
testTimeout: number;