Skip to content

Commit

Permalink
chore(#464): update story description
Browse files Browse the repository at this point in the history
  • Loading branch information
Decipher committed Mar 7, 2022
1 parent 7536e5a commit 48a9bff
Show file tree
Hide file tree
Showing 12 changed files with 66 additions and 22 deletions.
8 changes: 6 additions & 2 deletions packages/blocks/templates/druxt-block-region.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtBlockRegion component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBlockRegion component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -74,7 +76,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtBlockRegion component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBlockRegion component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/blocks/templates/druxt-block.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtBlock component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBlock component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -72,7 +74,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtBlock component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBlock component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand Down
8 changes: 6 additions & 2 deletions packages/breadcrumb/templates/druxt-breadcrumb.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtBreadcrumb component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBreadcrumb component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -60,7 +62,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtBreadcrumb component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtBreadcrumb component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/druxt/templates/stories/druxt-debug.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ Json.args = {
}
Json.parameters = {
docs: {
storyDescription: 'The **json** prop takes any data and runs it through a basic JSON formatter for improved readability.',
description: {
story: 'The **json** prop takes any data and runs it through a basic JSON formatter for improved readability.',
},
source: {
code: '<DruxtDebug :json="entity" open>Debug information</DruxtDebug>'
},
Expand All @@ -40,7 +42,9 @@ Summary.args = {
}
Summary.parameters = {
docs: {
storyDescription: 'The **summary** prop can be used to provide a quick explanation of the debug component.',
description: {
story: 'The **summary** prop can be used to provide a quick explanation of the debug component.',
},
source: {
code: `<DruxtDebug summary="${Summary.args.sumary}">Debug information</DruxtDebug>`
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ export const <%= mode.charAt(0).toUpperCase() + mode.slice(1) %> = Template.bind
}
<%= mode.charAt(0).toUpperCase() + mode.slice(1) %>.parameters = {
docs: {
storyDescription: 'Render the content entity form using the **<%= mode %>** display mode.',
description: {
story: 'Render the content entity form using the **<%= mode %>** display mode.',
},
source: {
code: '<DruxtEntityForm\n mode="<%= mode %>"\n type="<%= options.resourceType %>"\n uuid=<%= devalue(((options.entities || [])[0] || {}).id || false) %>\n/>'
}
Expand Down
8 changes: 6 additions & 2 deletions packages/entity/templates/druxt-entity-form.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtEntityForm component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtEntityForm component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -70,7 +72,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtEntityForm component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtEntityForm component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
4 changes: 3 additions & 1 deletion packages/entity/templates/druxt-entity.instance.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ export const <%= mode.charAt(0).toUpperCase() + mode.slice(1) %> = Template.bind
}
<%= mode.charAt(0).toUpperCase() + mode.slice(1) %>.parameters = {
docs: {
storyDescription: 'Render the content entity using the **<%= mode %>** display mode.',
description: {
story: 'Render the content entity using the **<%= mode %>** display mode.',
},
source: {
code: '<DruxtEntity\n mode="<%= mode %>"\n type="<%= options.resourceType %>"\n uuid=<%= devalue(((options.entities || [])[0] || {}).id || false) %>\n/>'
}
Expand Down
8 changes: 6 additions & 2 deletions packages/entity/templates/druxt-entity.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtEntity component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtEntity component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -71,7 +73,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtEntity component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtEntity component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/menu/templates/druxt-menu.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtMenu component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtMenu component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -66,7 +68,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtMenu component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtMenu component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/router/templates/druxt-router.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtRouter component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtRouter component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -59,7 +61,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtRouter component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtRouter component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/site/templates/druxt-site.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtSite component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtSite component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -69,7 +71,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtSite component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtSite component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
8 changes: 6 additions & 2 deletions packages/views/templates/druxt-views.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ export const Wrapper = (args, { argTypes }) => ({
})
Wrapper.parameters = {
docs: {
storyDescription: 'The DruxtView component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtView component can be themed by using a Druxt Wrapper component.\n\nCreate an appropriately named component, using the relevant component option, with the following boilerplate:\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}
Expand All @@ -76,7 +78,9 @@ export const TemplateInjection = (args, { argTypes }) => ({
})
TemplateInjection.parameters = {
docs: {
storyDescription: 'The DruxtView component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
description: {
story: 'The DruxtView component can be themed by injecting the default template into the compomnent.\n\n```jsx\n' + code + '\n```',
},
source: { code }
}
}

0 comments on commit 48a9bff

Please sign in to comment.