Skip to content

Commit 1503f2a

Browse files
committed
updating docsusaurusu and updating migration
1 parent a641cd0 commit 1503f2a

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

website/docs/legacy/v5/basics/helpers-javascript.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: JavaScript
1010

1111
Returns a camel-cased string.
1212

13-
* @param {string} string Add string to convert.
13+
* @param string string Add string to convert.
1414

1515
**Usage:**
1616

@@ -30,11 +30,11 @@ newSuperTestTitle
3030

3131
Checks whether the attributes exist in the attributes list. If the value is not set, it checks for the default value. If the default value is not set, it adds a fallback value depending on the type, or if `undefinedAllowed` is set to `true`, it sets it to `undefined`.
3232

33-
* @param {string} key Key to check.
34-
* @param {array} attributes Array of attributes.
35-
* @param {array} manifest Array of default attributes from manifest.json.
36-
* @param {string} componentName The real component name.
37-
* @param {boolean} undefinedAllowed Allowed detection of undefined values.
33+
* @param string key Key to check.
34+
* @param array attributes Array of attributes.
35+
* @param array manifest Array of default attributes from manifest.json.
36+
* @param string componentName The real component name.
37+
* @param boolean undefinedAllowed Allowed detection of undefined values.
3838

3939
**Usage:**
4040

@@ -48,11 +48,11 @@ Checks whether the attributes exist in the attributes list. If the value is not
4848

4949
Map and check attributes for responsive object from `responsiveAttributes` property from manifest.
5050

51-
* @param {string} keyName Key name to find in responsiveAttributes object.
52-
* @param {array} attributes Array of attributes.
53-
* @param {array} manifest Array of default attributes from manifest.json.
54-
* @param {string} componentName The real component name.
55-
* @param {boolean} undefinedAllowed Allowed detection of undefined values.
51+
* @param string keyName Key name to find in responsiveAttributes object.
52+
* @param array attributes Array of attributes.
53+
* @param array manifest Array of default attributes from manifest.json.
54+
* @param string componentName The real component name.
55+
* @param boolean undefinedAllowed Allowed detection of undefined values.
5656
* @throws \Exception If missing responsiveAttributes or keyName in responsiveAttributes.
5757
* @throws \Exception If missing keyName in responsiveAttributes.
5858
* @return mixed
@@ -132,7 +132,7 @@ Used to set and get cookie values.
132132
Debounces the provided function. For more information, check [this blog post](https://davidwalsh.name/javascript-debounce-function).
133133

134134
* @param func Provided function to apply debounce.
135-
* @param {int} wait Wait time for debounce.
135+
* @param int wait Wait time for debounce.
136136

137137
**Usage:**
138138

@@ -160,7 +160,7 @@ Checks if your browser's navigator is a specific device.
160160

161161
Used to get (require) all the files using the `require.context` method. It will find all files recursively in the folder using a regex. The following example will require all assets/index.js files inside the custom folder, so there is no need to manually add the files to the build.
162162

163-
* @param {object} paths All require.context patch to iterate.
163+
* @param object paths All require.context patch to iterate.
164164

165165
**Usage:**
166166

@@ -174,7 +174,7 @@ Used to get (require) all the files using the `require.context` method. It will
174174

175175
Returns the height of the element measured by the height of its children.
176176

177-
* @param {object} element DOM element
177+
* @param object element DOM element
178178

179179
**Usage:**
180180

@@ -196,7 +196,7 @@ elementChildrenHeight('.js-item');
196196

197197
Takes the provided string and removes special characters. Characters that will be removed: `([;&,.+*~':"!^#$%@[\]()=>|]`.
198198

199-
* @param {string} $key Key to check.
199+
* @param string $key Key to check.
200200

201201
**Usage:**
202202

@@ -212,10 +212,10 @@ Create responsive selectors used for responsive attributes.
212212

213213
Useful if you want to show how the responsive behavior looks in the editor.
214214

215-
* @param {array} items Array of breakpoints.
216-
* @param {string} selector Selector for this breakpoint.
217-
* @param {string} parent Parent block selector.
218-
* @param {boolean} use_modifier If false, you can use this selector for visibility.
215+
* @param array items Array of breakpoints.
216+
* @param string selector Selector for this breakpoint.
217+
* @param string parent Parent block selector.
218+
* @param boolean use_modifier If false, you can use this selector for visibility.
219219

220220
**Usage:**
221221

@@ -235,11 +235,11 @@ Useful if you want to show how the responsive behavior looks in the editor.
235235

236236
Returns BEM selector for HTML class and checks if the condition part is set.
237237

238-
* @param {boolean} condition Check condition.
239-
* @param {string} block BEM Block selector.
240-
* @param {string} element BEM Element selector.
241-
* @param {string} modifier BEM Modifier selector.
242-
* @return {string}
238+
* @param boolean condition Check condition.
239+
* @param string block BEM Block selector.
240+
* @param string element BEM Element selector.
241+
* @param string modifier BEM Modifier selector.
242+
* @return string
243243

244244
**Usage:**
245245

@@ -268,7 +268,7 @@ Returns BEM selector for HTML class and checks if the condition part is set.
268268

269269
Use this hook to filter the global colors out of the component or block manifest
270270

271-
* @param {array} colors Array of colors to filter.
271+
* @param array colors Array of colors to filter.
272272

273273
**Usage:**
274274

@@ -293,10 +293,10 @@ import { getOptions } from '@eightshift/frontend-libs/scripts/editor';
293293
Provides the ability to override component options from the parent block/component.
294294
The components must have the same option names as attribute standard with `componentName` prefix.
295295

296-
* @param {object} manifest Original manifest from the component.
297-
* @param {string} componentName Current componentName. This is changed depending on the passed componentName.
298-
* @param {string} attribute Attribute name to check without componentName prefix. Value is auto camelCased.
299-
* @param {object} options Options provided by the parent block/component.
296+
* @param object manifest Original manifest from the component.
297+
* @param string componentName Current componentName. This is changed depending on the passed componentName.
298+
* @param string attribute Attribute name to check without componentName prefix. Value is auto camelCased.
299+
* @param object options Options provided by the parent block/component.
300300

301301
**Usage:**
302302

@@ -488,11 +488,11 @@ Used to set attributes on all innerBlocks preset only for simple wrapper setup.
488488

489489
Output only attributes that are used in the component and remove everything else.
490490

491-
* @param {object} attributes Object of attributes from block/component.
492-
* @param {string} realName Old key to use, generally this is the name of the block/component.
493-
* @param {string} newName New key to use to rename attributes.
494-
* @param {boolean} isBlock Check if helper is used on block or component.
495-
* @param {string} globalManifestData If global manifest is not provided use the default path.
491+
* @param object attributes Object of attributes from block/component.
492+
* @param string realName Old key to use, generally this is the name of the block/component.
493+
* @param string newName New key to use to rename attributes.
494+
* @param boolean isBlock Check if helper is used on block or component.
495+
* @param string globalManifestData If global manifest is not provided use the default path.
496496

497497
**Data:**
498498
```js

website/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@eightshift/docs",
3-
"version": "7.0.0",
3+
"version": "8.0.0",
44
"description": "A documentation website for Eightshift open source projects.",
55
"author": {
66
"name": "Eightshift team",

0 commit comments

Comments
 (0)