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

feat: add annotations support for addons #612

Open
wants to merge 9 commits into
base: next
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions examples/expo-example/.storybook-web/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const main: ServerStorybookConfig = {
'@storybook/addon-react-native-web',
// note why does this break with get absolute?
'@storybook/addon-react-native-server',
'storybook-addon-deep-controls',
],
// logLevel: 'debug',
framework: getAbsolutePath('@storybook/react-webpack5'),
Expand Down
1 change: 1 addition & 0 deletions examples/expo-example/.storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const main: StorybookConfig = {
'@storybook/addon-ondevice-backgrounds',
'@storybook/addon-ondevice-actions',
'@storybook/addon-ondevice-notes',
'storybook-addon-deep-controls',
],
reactNative: {
playFn: false,
Expand Down
1 change: 1 addition & 0 deletions examples/expo-example/.storybook/preview.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import React from 'react';
import { View, Appearance } from 'react-native';
import { withBackgrounds } from '@storybook/addon-ondevice-backgrounds';
import type { Preview } from '@storybook/react';
Expand Down
4 changes: 3 additions & 1 deletion examples/expo-example/.storybook/storybook.requires.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import "@storybook/addon-ondevice-controls/register";
import "@storybook/addon-ondevice-backgrounds/register";
import "@storybook/addon-ondevice-actions/register";
import "@storybook/addon-ondevice-notes/register";
import "storybook-addon-deep-controls/register";

const normalizedStories = [
{
Expand Down Expand Up @@ -57,7 +58,8 @@ declare global {
const annotations = [
require("./preview"),
require("@storybook/react-native/dist/preview"),
require("@storybook/addon-actions/preview"),
require("@storybook/addon-ondevice-actions/preview"),
require("storybook-addon-deep-controls/preview"),
];

global.STORIES = normalizedStories;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { Meta, StoryObj } from '@storybook/react';
import React from 'react';
import { Text } from 'react-native';

const DeepControls = () => {
return <Text>Testing story with deep controls (storybook-addon-deep-controls)</Text>;
};

export default {
title: 'DeepControls',
component: DeepControls,
} satisfies Meta<typeof DeepControls>;

export const Basic: StoryObj<typeof DeepControls> = {
parameters: {
deepControls: { enabled: true },
},
args: {
objectArg: {
string: 'foo',
number: 42,
boolean: true,
enumString: 'value2', // we only want specific values for this
nested: {
number: 222,
boolean: false,
},
},
},
argTypes: {
// so we define an argType for the property to use a radio control with specific values
'objectArg.enumString': {
control: 'radio',
options: ['value1', 'value2', 'value3'],
},
},
};
1 change: 1 addition & 0 deletions examples/expo-example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"react-native-web": "~0.19.10",
"react-router": "^6.26.2",
"storybook": "^8.3.5",
"storybook-addon-deep-controls": "^0.8.2",
"ws": "^8.18.0"
},
"devDependencies": {
Expand Down
1 change: 1 addition & 0 deletions packages/ondevice-actions/preview.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from '@storybook/addon-actions/preview';
1 change: 1 addition & 0 deletions packages/ondevice-actions/src/preview.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from '@storybook/addon-actions/preview';
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import "@storybook/addon-ondevice-actions/register";
}


const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-actions/preview')];
const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-ondevice-actions/preview')];

global.STORIES = normalizedStories;

Expand Down Expand Up @@ -77,7 +77,7 @@ import "@storybook/addon-ondevice-actions/register";
}


const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-actions/preview')];
const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-ondevice-actions/preview')];

global.STORIES = normalizedStories;

Expand Down Expand Up @@ -127,7 +127,7 @@ import "@storybook/addon-ondevice-actions/register";
}


const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-actions/preview')];
const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-ondevice-actions/preview')];

global.STORIES = normalizedStories;

Expand Down Expand Up @@ -177,7 +177,7 @@ import "@storybook/addon-ondevice-actions/register";
}


const annotations = [require("@storybook/react-native/dist/preview"), require('@storybook/addon-actions/preview')];
const annotations = [require("@storybook/react-native/dist/preview"), require('@storybook/addon-ondevice-actions/preview')];

global.STORIES = normalizedStories;

Expand Down Expand Up @@ -222,7 +222,7 @@ import "@storybook/addon-ondevice-actions/register";



const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-actions/preview')];
const annotations = [require('./preview'),require("@storybook/react-native/dist/preview"), require('@storybook/addon-ondevice-actions/preview')];

global.STORIES = normalizedStories;

Expand Down
19 changes: 15 additions & 4 deletions packages/react-native/scripts/generate.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,21 @@ function generate({ configPath, absolute = false, useJs = false }) {

const doctools = 'require("@storybook/react-native/dist/preview")';

// TODO: implement presets or something similar
const enhancer = main.addons?.includes('@storybook/addon-ondevice-actions')
? "require('@storybook/addon-actions/preview')"
: '';
const enhancer = [];

main.addons?.forEach((addon) => {
let addonPath;
try {
addonPath = path.dirname(require.resolve(addon));
} catch (error) {
console.error(`Failed to resolve addon: ${addon}`, error);
return null; // Skip this addon if it cannot be resolved
}
const isPreviewFileExists = getPreviewExists({ configPath: addonPath });
if (isPreviewFileExists) {
enhancer.push(`require('${addon}/preview')`);
}
});

let options = '';
let optionsVar = '';
Expand Down
12 changes: 12 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -9730,6 +9730,7 @@ __metadata:
react-native-web: "npm:~0.19.10"
react-router: "npm:^6.26.2"
storybook: "npm:^8.3.5"
storybook-addon-deep-controls: "npm:^0.8.2"
typescript: "npm:^5.3.3"
ws: "npm:^8.18.0"
languageName: unknown
Expand Down Expand Up @@ -17640,6 +17641,17 @@ __metadata:
languageName: node
linkType: hard

"storybook-addon-deep-controls@npm:^0.8.2":
version: 0.8.2
resolution: "storybook-addon-deep-controls@npm:0.8.2"
peerDependencies:
"@storybook/addon-controls": 7.x.x || 8.x.x
"@storybook/types": 7.x.x || 8.x.x
storybook: 7.x.x || 8.x.x
checksum: 10/79fcd1f96d0e9472b195d14335268d2bab9da087ab348f1e243349acb69265e552536ea57f0d885a317c9f6f48a130d358f73f392aab68f56401c3a4010f70ec
languageName: node
linkType: hard

"storybook@npm:^8.3.5":
version: 8.3.5
resolution: "storybook@npm:8.3.5"
Expand Down