Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history 
Update docs.
Update docs.
Update docs.
Update doc.
Update docs.
Update docs.
Update docs.
Update doc.
Update doc.
Update doc.
  • Loading branch information
@sainthkh
sainthkh committed Mar 29, 2020
1 parent 30fdcdb commit c72d628
Show file tree
Hide file tree
Showing 31 changed files with 862 additions and 862 deletions.
336 changes: 168 additions & 168 deletions docs/designers-developers/developers/data/data-core-block-editor.md
View file

Large diffs are not rendered by default.

114 changes: 57 additions & 57 deletions docs/designers-developers/developers/data/data-core-blocks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,48 +12,48 @@ Returns block styles by block name.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _name_ `string`: Block type name.

_Returns_

- `?Array`: Block Styles.
- `Array | null`: Block Styles.

<a name="getBlockSupport" href="#getBlockSupport">#</a> **getBlockSupport**

Returns the block support value for a feature, if defined.

_Parameters_

- _state_ `Object`: Data state.
- _nameOrType_ `(string|Object)`: Block name or type object
- _state_ `object`: Data state.
- _nameOrType_ `( string | object )`: Block name or type object
- _feature_ `string`: Feature to retrieve
- _defaultSupports_ `*`: Default value to return if not explicitly defined
- _defaultSupports_ `any`: Default value to return if not explicitly defined

_Returns_

- `?*`: Block support value
- `any | null`: Block support value

<a name="getBlockType" href="#getBlockType">#</a> **getBlockType**

Returns a block type by name.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _name_ `string`: Block type name.

_Returns_

- `?Object`: Block Type.
- `object | null`: Block Type.

<a name="getBlockTypes" href="#getBlockTypes">#</a> **getBlockTypes**

Returns all the available block types.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

Expand All @@ -65,21 +65,21 @@ Returns block variations by block name.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _blockName_ `string`: Block type name.
- _scope_ `[WPBlockVariationScope]`: Block variation scope name.
- _scope_ `WPBlockVariationScope | undefined`: Block variation scope name.

_Returns_

- `(Array<WPBlockVariation>|void)`: Block variations.
- `( WPBlockVariation[] | void )`: Block variations.

<a name="getCategories" href="#getCategories">#</a> **getCategories**

Returns all the available categories.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

Expand All @@ -91,7 +91,7 @@ Returns an array with the child blocks of a given block.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _blockName_ `string`: Block type name.

_Returns_
Expand All @@ -104,23 +104,23 @@ Returns all the available collections.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

- `Object`: Collections list.
- `object`: Collections list.

<a name="getDefaultBlockName" href="#getDefaultBlockName">#</a> **getDefaultBlockName**

Returns the name of the default block name.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

- `?string`: Default block name.
- `string | null`: Default block name.

<a name="getDefaultBlockVariation" href="#getDefaultBlockVariation">#</a> **getDefaultBlockVariation**

Expand All @@ -131,58 +131,58 @@ When there is no default variation set, it returns the first item.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _blockName_ `string`: Block type name.
- _scope_ `[WPBlockVariationScope]`: Block variation scope name.
- _scope_ `WPBlockVariationScope | undefined`: Block variation scope name.

_Returns_

- `?WPBlockVariation`: The default block variation.
- `WPBlockVariation | null`: The default block variation.

<a name="getFreeformFallbackBlockName" href="#getFreeformFallbackBlockName">#</a> **getFreeformFallbackBlockName**

Returns the name of the block for handling non-block content.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

- `?string`: Name of the block for handling non-block content.
- `string | null`: Name of the block for handling non-block content.

<a name="getGroupingBlockName" href="#getGroupingBlockName">#</a> **getGroupingBlockName**

Returns the name of the block for handling unregistered blocks.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

- `?string`: Name of the block for handling unregistered blocks.
- `string | null`: Name of the block for handling unregistered blocks.

<a name="getUnregisteredFallbackBlockName" href="#getUnregisteredFallbackBlockName">#</a> **getUnregisteredFallbackBlockName**

Returns the name of the block for handling unregistered blocks.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.

_Returns_

- `?string`: Name of the block for handling unregistered blocks.
- `string | null`: Name of the block for handling unregistered blocks.

<a name="hasBlockSupport" href="#hasBlockSupport">#</a> **hasBlockSupport**

Returns true if the block defines support for a feature, or false otherwise.

_Parameters_

- _state_ `Object`: Data state.
- _nameOrType_ `(string|Object)`: Block name or type object.
- _state_ `object`: Data state.
- _nameOrType_ `( string | object )`: Block name or type object.
- _feature_ `string`: Feature to test.
- _defaultSupports_ `boolean`: Whether feature is supported by default if not explicitly defined.

Expand All @@ -196,7 +196,7 @@ Returns a boolean indicating if a block has child blocks or not.

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _blockName_ `string`: Block type name.

_Returns_
Expand All @@ -209,7 +209,7 @@ Returns a boolean indicating if a block has at least one child block with insert

_Parameters_

- _state_ `Object`: Data state.
- _state_ `object`: Data state.
- _blockName_ `string`: Block type name.

_Returns_
Expand All @@ -223,13 +223,13 @@ search term, or false otherwise.

_Parameters_

- _state_ `Object`: Blocks state.
- _nameOrType_ `(string|Object)`: Block name or type object.
- _state_ `object`: Blocks state.
- _nameOrType_ `( string | object )`: Block name or type object.
- _searchTerm_ `string`: Search term by which to filter.

_Returns_

- `Array<Object>`: Whether block type matches search term.
- `object[]`: Whether block type matches search term.

<!-- END TOKEN(Autogenerated selectors|../../../../packages/blocks/src/store/selectors.js) -->

Expand All @@ -245,11 +245,11 @@ _Parameters_

- _namespace_ `string`: The namespace of the blocks to put in the collection
- _title_ `string`: The title to display in the block inserter
- _icon_ `Object`: (optional) The icon to display in the block inserter
- _icon_ `object`: (optional) The icon to display in the block inserter

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="addBlockStyles" href="#addBlockStyles">#</a> **addBlockStyles**

Expand All @@ -258,23 +258,23 @@ Returns an action object used in signalling that new block styles have been adde
_Parameters_

- _blockName_ `string`: Block name.
- _styles_ `(Array|Object)`: Block styles.
- _styles_ `Array | object`: Block styles.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="addBlockTypes" href="#addBlockTypes">#</a> **addBlockTypes**

Returns an action object used in signalling that block types have been added.

_Parameters_

- _blockTypes_ `(Array|Object)`: Block types received.
- _blockTypes_ `Array | object`: Block types received.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="addBlockVariations" href="#addBlockVariations">#</a> **addBlockVariations**

Expand All @@ -283,11 +283,11 @@ Returns an action object used in signalling that new block variations have been
_Parameters_

- _blockName_ `string`: Block name.
- _variations_ `(WPBlockVariation|Array<WPBlockVariation>)`: Block variations.
- _variations_ `WPBlockVariation | WPBlockVariation[]`: Block variations.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="removeBlockCollection" href="#removeBlockCollection">#</a> **removeBlockCollection**

Expand All @@ -299,7 +299,7 @@ _Parameters_

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="removeBlockStyles" href="#removeBlockStyles">#</a> **removeBlockStyles**

Expand All @@ -308,23 +308,23 @@ Returns an action object used in signalling that block styles have been removed.
_Parameters_

- _blockName_ `string`: Block name.
- _styleNames_ `(Array|string)`: Block style names.
- _styleNames_ `Array | string`: Block style names.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="removeBlockTypes" href="#removeBlockTypes">#</a> **removeBlockTypes**

Returns an action object used to remove a registered block type.

_Parameters_

- _names_ `(string|Array)`: Block name.
- _names_ `string | Array`: Block name.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="removeBlockVariations" href="#removeBlockVariations">#</a> **removeBlockVariations**

Expand All @@ -333,23 +333,23 @@ Returns an action object used in signalling that block variations have been remo
_Parameters_

- _blockName_ `string`: Block name.
- _variationNames_ `(string|Array<string>)`: Block variation names.
- _variationNames_ `string | string[]`: Block variation names.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="setCategories" href="#setCategories">#</a> **setCategories**

Returns an action object used to set block categories.

_Parameters_

- _categories_ `Array<Object>`: Block categories.
- _categories_ `object[]`: Block categories.

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="setDefaultBlockName" href="#setDefaultBlockName">#</a> **setDefaultBlockName**

Expand All @@ -361,7 +361,7 @@ _Parameters_

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="setFreeformFallbackBlockName" href="#setFreeformFallbackBlockName">#</a> **setFreeformFallbackBlockName**

Expand All @@ -374,7 +374,7 @@ _Parameters_

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="setGroupingBlockName" href="#setGroupingBlockName">#</a> **setGroupingBlockName**

Expand All @@ -388,7 +388,7 @@ _Parameters_

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="setUnregisteredFallbackBlockName" href="#setUnregisteredFallbackBlockName">#</a> **setUnregisteredFallbackBlockName**

Expand All @@ -401,7 +401,7 @@ _Parameters_

_Returns_

- `Object`: Action object.
- `object`: Action object.

<a name="updateCategory" href="#updateCategory">#</a> **updateCategory**

Expand All @@ -410,11 +410,11 @@ Returns an action object used to update a category.
_Parameters_

- _slug_ `string`: Block category slug.
- _category_ `Object`: Object containing the category properties that should be updated.
- _category_ `object`: Object containing the category properties that should be updated.

_Returns_

- `Object`: Action object.
- `object`: Action object.


<!-- END TOKEN(Autogenerated actions|../../../../packages/blocks/src/store/actions.js) -->
Loading

0 comments on commit c72d628

Please sign in to comment.