Skip to content

Commit

Permalink
fix: update documentation (#611)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeksandla authored Oct 5, 2023
1 parent 2f86fab commit 14ee88e
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .storybook/stories/documentation/Blocks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Each block has the following common properties:
bottom?: string
}` - block indentation at the top and bottom, default size `l`, examples you can see [here](?path=/story/blocks-cardlayout--with-custom-indents)

_[Common field types](?id=information--common-types&viewMode=docs)_
_[Common field types](?id=documentation-types&viewMode=docs)_

## [Banner](?path=/story/blocks-banner--docs&viewMode=docs)

Expand Down
4 changes: 2 additions & 2 deletions .storybook/stories/documentation/Types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ import { Meta } from '@storybook/blocks';

- `color?: string` — Background color
- [`image?: ImageObjectProps | ImageObjectProps[] | ImageDeviceProps` — Background image](#ImageObjectProps). If you pass an array, the full-screen mode is automatically turned on.
- `parallax?: bool` — Enable/disable the parallax effect
- `parallax?: boolean` — Enable/disable the parallax effect
- [`video?: Video` — Video](#Video)
- `youtube?: url` — Link to a video on YouTube
- `height?: number` — Block height
- `previewImg?: string`
- `dataLens?: string |` [DataLens](#DataLens)
- `fullscreen?: bool` — Enabling full-screen mode for image or video
- `fullscreen?: boolean` — Enabling full-screen mode for image or video. Default true - for multiple images, false - for single image, video. It doesn't work with dataLens and youtube

---

Expand Down
4 changes: 2 additions & 2 deletions src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import * as ExtendedFeaturesStories from './ExtendedFeatures.stories.tsx';
- `title?: string` — Item's title
- `text?: string` — Item's text (with YFM support)
- `additionalInfo?: string` — Gray text (with YFM support)
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
- `label?: New | Preview` — Label

`colSizes?: Object` — Sizes of a single card in columns for different screen sizes, the value ranges from 1 to 12 columns. If 12 columns, a single card takes up the entire width of the screen.
Expand Down
6 changes: 3 additions & 3 deletions src/blocks/Map/__stories__/Map.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import * as MapStories from './Map.stories.tsx';

`description: string` — Description.

[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button)
[`button: Button` — Button](?path=/docs/documentation-types--docs#button)

[`map: Map` — Map description](?path=/story/components-map--y-map&viewMode=docs)

Expand All @@ -28,7 +28,7 @@ import * as MapStories from './Map.stories.tsx';

`additionalInfo?: string` — Gray text (with YFM support)

[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link)
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)

[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button)
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)
</StoryTemplate>
8 changes: 4 additions & 4 deletions src/blocks/Media/__stories__/Media.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ import * as MediaStories from './Media.stories.tsx';

`description: string` — Description.

[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button)
[`button: Button` — Button](?path=/docs/documentation-types--docs#button)

[`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#common-types)
[`media: Media` — Media description](?path=/docs/documentation-types--docs)

`direction: 'media-content' | 'content-media'` — Relative position of media and content.

Expand All @@ -25,8 +25,8 @@ import * as MediaStories from './Media.stories.tsx';

`additionalInfo?: string` — Gray text (with YFM support)

[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link)
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)

[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button)
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)

</StoryTemplate>
4 changes: 2 additions & 2 deletions src/blocks/Questions/__stories__/Questions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ import * as QuestionsStories from './Questions.stories.tsx';

`additionalInfo?: string` — Gray text (with YFM support)

`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs))
`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/docs/documentation-types--docs))

`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs))
`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/docs/documentation-types--docs))

`items: QuestionItem[]`

Expand Down
6 changes: 3 additions & 3 deletions src/blocks/Tabs/__stories__/Tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ import * as TabsStories from './Tabs.stories.tsx';
- `title?: string` — Item's title
- `text?: string` — Item's text (with YFM support)
- `additionalInfo?: string` — Gray text (with YFM support)
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
- `image?: string | ImageObjectProps` — Image.
- [`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#media---picvideodatalens)
- [`media: Media` — Media description](?path=/docs/documentation-types#media--imagevideodatalensyoutube)
- `caption?: string` — Image caption.

</StoryTemplate>
4 changes: 2 additions & 2 deletions src/containers/PageConstructor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ PageConstructor container
- `color: string` - background color
- `animated: true | false` - background animation on load and on scroll
- `parallax?: true | false` — enable/disable the parallax effect
- `video?: Video` - [Video](?path=/story/information--common-types#Video)
- `image?: Image` - [ImageObjectProps](?path=/story/information--common-types#ImageObjectProps)
- `video?: Video` - [Video](?path=/docs/documentation-types--docs#Video)
- `image?: Image` - [ImageObjectProps](?path=/docs/documentation-types--docs#ImageObjectProps)
- `fullWidthMedia?: true | false` - Media width: Picture or Video to the entire screen width or as per column size.
- `height?: number` - height of media
4 changes: 2 additions & 2 deletions src/sub-blocks/BackgroundCard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@

`additionalInfo?: string` — Gray text (with YFM support)

`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))

`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
4 changes: 2 additions & 2 deletions src/sub-blocks/BasicCard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

`additionalInfo?: string` — Gray text (with YFM support)

`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))

`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))

`border: 'shadow' | 'line' | 'none'` — Card border properties (defaults to `'shadow'`).
6 changes: 3 additions & 3 deletions src/sub-blocks/Content/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[`title?: Title | string` - title](?path=/story/information--common-types&viewMode=docs#title---block-title)
[`title?: Title | string` - title](?path=/docs/documentation-types--docs#title-block-title)

`text?: string` — Text (with YFM support)

`additionalInfo?: string` — Gray text (with YFM support)

[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link)
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)

[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button)
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)

`centered?: false | true` - Aligns all content to the center ('false' by default)

Expand Down
6 changes: 3 additions & 3 deletions src/sub-blocks/Content/__stories__/Content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ import * as ContentStories from './Content.stories.tsx';

`additionalInfo?: string` — Gray text (with YFM support)

[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link--link)
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)

[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button--button)
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)

`centered?: false | true` - Aligns all content to the center ('false' by default)

Expand All @@ -32,7 +32,7 @@ import * as ContentStories from './Content.stories.tsx';
- `xl: number` — On a screen wider than 1185px.

`list: Array` - An Array of items with icon
- [`icon: string | ImageObjectProps` — Icon](?path=/docs/documentation-types--docs#imageobjectprops--image-property).
- [`icon: string | ImageObjectProps` — Icon](?path=/docs/documentation-types--docs#imageobjectprops---image-property).
- `title?: string` — Title.
- `text?: string` — Text (with YFM support)
</StoryTemplate>

0 comments on commit 14ee88e

Please sign in to comment.