Skip to content

Commit

Permalink
sb-breadcrumbs-block v0.4.0 - update readme and add first pass assets
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbingwide committed Jul 27, 2020
1 parent f5ac7b4 commit 1c43511
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 93 deletions.
73 changes: 16 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,49 @@
# SB Children block
![banner](https://raw.githubusercontent.com/bobbingwide/children-block/master/assets/children-block-banner-772x250.jpg)
# SB Breadcrumbs block
![banner](https://raw.githubusercontent.com/bobbingwide/sb-breadcrumbs-block/master/assets/sb-breadcrumbs-block-banner-772x250.jpg)
* Contributors: bobbingwide
* Tags: block, children, parent, links
* Tags: block, breadcrumbs, link
* Requires at least: 5.4.2
* Tested up to: 5.4.2
* Stable tag: 0.3.2
* Stable tag: 0.4.0
* Requires PHP: 7.2.0
* License: GPL-2.0-or-later
* License URI: https://www.gnu.org/licenses/gpl-2.0.html

List children of the current content as links.
Show Breadcrumb links to the current content.

## Description
The children-block provides two blocks

1. oik/children-block - to list children of the current content as links.
2. oik/parent-block - to display a link to the parent.
Use the Breadcrumbs block ( sb/breadcrumbs-block ) to display a links to the current content as a breadcrumb trail.
Works for any hierarchical post type such as pages.

## Installation

1. Upload the plugin files to the `/wp-content/plugins/children-block` directory, or install the plugin through the WordPress plugins screen directly.
1. Upload the plugin files to the `/wp-content/plugins/sb-breadcrumbs-block` directory, or install the plugin through the WordPress plugins screen directly.
1. Activate the plugin through the 'Plugins' screen in WordPress

## Frequently Asked Questions

# What are the values for the depth parameter?

- Value - Meaning
- 0 - Display all descendents in a tree
- 1 - Display Children only
- 2 - Display Children and Grandchildren
- > 2 - Display more descendents
- -1 - Display all descendents in a list

# Why doesn't the parent block show multiple levels?

That could be implemented using another block; a breadcrumbs block.

## Screenshots
1. Children block depth=0
2. Children block depth=1
3. Children block depth=-1
1. breadcrumbs block

## Upgrade Notice
# 0.3.2
Upgrade for some improved usage notes.

# 0.3.1
Upgrade for some usage notes.

# 0.3.0
Use the Parent block in child pages to link back to the parent page.
# 0.4.0
Use the breadcrumbs block (sb/breadcrumbs-block) from the SB breadcrumbs block plugin when you need to show links to all the current posts' ancestors.

# 0.2.0
Now implements the child list using server side rendering and supports the depth parameter

# 0.1.0
Initial version generated by npm wp-create-block

## Changelog
# 0.3.2
* Changed: Attempted to improve usage notes in the readme.

# 0.3.1
* Changed: Add screenshots, banner and update the readme.

# 0.3.0
* Added: Parent block https://github.com/bobbingwide/children-block/issues/3
* Changed: Prepare for multiple blocks https://github.com/bobbingwide/children-block/issues/2
* Tested: With WordPress 5.4.2 and WordPress Multi Site
* Tested: With PHP 7.3 and PHP 7.4

# 0.2.0
* Changed: Now implements the child list using server side rendering and supports the depth= parameter https://github.com/bobbingwide/children-block/issues/1

# 0.1.0
* First version as generated by npm wp-create-block
# 0.4.0
* Changed: Copied and cobbled from SB Parent block plugin.

## Build process

- To build the blocks during development.
- To build the block during development.

`npm start`

Press Ctrl-C to to stop process.

- To build the blocks for runtime.
- To build the block for runtime.

`npm run build`

Expand All @@ -102,3 +60,4 @@ For some basic instructions see the [oik-blocks summary of blocks README](https:
Most people run the `npm` command from the command line.



Binary file added assets/sb-breadcrumbs-block-banner-772x250.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/sb-breadcrumbs-block-icon-256x256.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 0 additions & 35 deletions languages/block-builder.pot

This file was deleted.

2 changes: 1 addition & 1 deletion readme.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== SB Breadcumbs block ===
=== SB Breadcrumbs block ===
Contributors: bobbingwide
Tags: block, breadcrumbs, link
Requires at least: 5.4.2
Expand Down

0 comments on commit 1c43511

Please sign in to comment.