Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix screenshot rendering without styles #19

Merged
merged 1 commit into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .storybook/local-preset.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
/**
* to load the built addon in this test Storybook
*/
function previewAnnotations(entry = []) {
return [...entry, require.resolve('../dist/preview.js')];
}

function managerEntries(entry = []) {
return [...entry, require.resolve('../dist/manager.js')];
}

module.exports = {
managerEntries,
previewAnnotations,
};
1 change: 0 additions & 1 deletion .storybook/preview-head.html

This file was deleted.

3 changes: 1 addition & 2 deletions .storybook/preview.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
const preview = {
parameters: {
marker: {
destination: '60f162459a86003bf9d741b3',
mode: 'advanced'
project: '60f162459a86003bf9d741b3',
}
}
};
Expand Down
1 change: 0 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
"source.fixAll.eslint": "explicit"
},
"eslint.format.enable": true,
"js/ts.implicitProjectConfig.checkJs": true
}
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ A Storybook Addon to add a [Marker.io](https://marker.io/) feedback button in [S
npm install @etchteam/storybook-addon-marker --save-dev
```

## Configuration

### Storybook
## Configuring Storybook

Create a file called `main.js` in your `.storybook` config folder.

Expand All @@ -24,34 +22,44 @@ export default {
}
```

Then create a file called `preview.js` in the same folder and add your [Marker destination](https://marker.io/blog/integrate-web-app-browser-sdk) as a [parameter](https://storybook.js.org/docs/react/writing-stories/parameters).
Then create a file called `preview.js` in the same folder and add your [Marker project ID](https://marker.io/blog/integrate-web-app-browser-sdk) as a [parameter](https://storybook.js.org/docs/react/writing-stories/parameters).

```js
export default {
parameters: {
marker: {
destination: 'abcd1234567890', // <- Your unique destination ID
project: 'abcd1234567890', // Your unique project ID
}
}
}
```

To set the type of capture to trigger, the optional `mode` property can be added to the marker options:
Only `project` is required, the [rest of the marker widget params](https://github.com/marker-io/browser-sdk/blob/b5b3b9b19c7525be7dfa3f92b745f74f8e305303/src/index.ts#L7) are accepted and will be passed down to [the `loadWidget` method](https://github.com/marker-io/browser-sdk?tab=readme-ov-file#method-1-passing-custom-metadata-while-loading-your-widget).

Additionally, the `mode` option of [the browser SDK `capture` method](https://github.com/marker-io/browser-sdk?tab=readme-ov-file#widgetcapturemode) can be added to this config:

```js
export const parameters = {
marker: {
destination: 'abcd1234567890', // <- Your unique destination ID
project: 'abcd1234567890', // <- Your unique project ID
mode: 'fullscreen', // fullscreen | advanced
}
}
```

### Marker
## Configuring Marker

Guidance on how to locate your Marker project and other Marker configuration options can be found on the [Marker website](https://help.marker.io/en/collections/3646812-configuration).

### Hiding the Marker widget button

This addon places a feedback button in the Storybook toolbar and automatically hides the default Marker button.

If you're finding the duplicate button still appears, there is a Marker setting under Widget > Button > Button visibility that can be set to "hidden".

Your Marker destination and other Marker configuration options can be found on the [Marker SDK documentation](https://marker.io/blog/integrate-web-app-browser-sdk).
### Screenshot rendering

The Widget > Button > Button visibility setting should be set to "hidden" as this addon adds a custom feedback button to the Storybook toolbar.
If screenshots aren’t rendering correctly check [Markers tips and limitations](https://help.marker.io/en/articles/6282853-widget-screenshot-tips-limitations#h_96fa6c657e).

---

Expand Down
Loading