content-blocks-builder / readme.txt

readme.txt in Content Blocks Builder – Create blocks, repeater blocks with carousel, grid, popup layouts 2.7.8, at readme.txt

316 lines 20.2 KB

Raw Download Zip

1	=== Content Blocks Builder - Create block, variation, repeater block with carousel, grid, accordion, popup, off-canvas layout ===
2	Contributors: Mr2P, freemius
3	Donate link: https://contentblocksbuilder.com?utm_source=wp.org&utm_campaign=readme&utm_medium=link&utm_content=CBB+Donate
4	Tags: blocks, block builder, carousel, grid, popup
5	Requires PHP: 7.4
6	Requires at least: 6.6
7	Tested up to: 6.7
8	Stable tag: 2.7.8
9	License: GPL-3.0
10	License URI: https://www.gnu.org/licenses/gpl-3.0.html
11
12	Create your WordPress site easier and faster directly in the Gutenberg Block Editor without coding using core blocks and block themes.
13
14	== Description ==
15
16	Content Blocks Builder (CBB) is a tool that helps you create custom blocks, variations, styles, and patterns directly in the Block Editor without using a code editor.
17
18	WordPress, with its Gutenberg Block Editor, provides a robust foundation for building websites. However, when you need something more specific or unique features that are not available in the default blocks, you have to build custom solutions or explore third-party options. CBB is designed to help you create those unique layouts and features easily, eliminating the need to seek out third-party plugins.
19
20	The core feature of CBB is to create custom blocks by grouping core blocks or third-party blocks into a container block. This container block offers native features such as typography, colors, spacing, border, etc., along with a bunch of custom advanced features that help you create common layouts such as grid, carousel, accordion, modal, off-canvas, etc. You can also create repeater blocks to display repeating content that works similarly to the ACF repeater field. For more information, please check out [the detailed guide about CBB blocks](https://contentblocksbuilder.com/documentation/custom-blocks/?utm_source=wp.org&utm_campaign=readme&utm_medium=link&utm_content=CBB+Blocks).
21
22	The goal of CBB is to help you build a complex website with WordPress using only core blocks and native Gutenberg features with any block theme.
23
24	=== Key technical features ===
25
26	- Manage custom blocks: Create, edit, copy, import, and delete custom blocks.
27	- Create repeater blocks that work similarly to ACF repeater fields. Supports carousel, grid, accordion and vertical stack layouts.
28	- [[CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB)] Extenral CSS/JS and Custom CSS/JS: You can enqueue external CSS/JS and write custom CSS/JS for your blocks
29	- Advanced block support features: Modal, off-canvas, toggle content, sticky, responsive dimensions, spacing, custom attributes, reveal animations, etc.
30	- Manage block variations & block styles: Create, edit, copy, import, and delete block variations. It works on any block. [CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB) enables you to input custom CSS for variations.
31	- Manage block patterns: Create, edit, copy, import, and delete custom block patterns.
32	- Enhance the Query Loop block: Add grid, carousel layouts, and advanced filter and sorting settings. Works with any post types.
33	- Import/export custom blocks, variations, and patterns from/to other sites
34	- Pre-built library: A library of pre-built blocks, variations, styles, and patterns. This library is not bundled with CBB; only items you import appear on your site.
35	- CBB are built with vanilla JS and CSS. It depends only [SwiperJs](https://swiperjs.com/) for the carousel script.
36
37	=== Practical features you can build with CBB ===
38
39	- Carousel layouts: Ideal for creating banner slider, posts carousel, gallery, carousel of features or other repeating content, etc. CBB provides one of the best way to create a carousel layout in Gutenberg. Built on top of the popular SwiperJs carousel script, it supports extensive customization. [CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB) enables you to create entrance effects, advanced slide effects with effect builder, and further customization like slides per breakpoint, pagination, navigation, and synced carousels.
40	- Responsive grid layouts: Perfect for creating equal column grid, mosaic grid, bento grid, posts grid, grid of features or other repeating content, etc. CBB provides the easiest but most flexible and robost grid layout based on CSS Grid layout. You can customize template columns, grid gaps, size, and location for each grid item.
41	- Accordion layouts: Good for creating FAQ page, navigations, long features or specications.
42	- Blog page design, magazine layout, post grid, post carousel; Work with any post types.
43	- Modal, off-canvas, popover, toggle content: Great for creating popups, notification bars, toggle menu, toggle search box, hamburger menu, popover, show/hide content, etc. [CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB) allows you to add a custom entrance animation effect, delay to appear of the blocks, and save the closed state of blocks.
44	- Sticky content: Great for fixed/sticky header, footer, floating elements, sticky sidebar. [CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB) enables you to style blocks based on their stuck state and make blocks sticky only when scrolling up.
45	- [[CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB)] Backgound effect: Add parallax, infinite scrolling, and zooming effect to image easily. Perfect for hero section designs.
46	- [[CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB)] Reveal animations: Add stunning effects to blocks when they appear on the viewport the first time.
47	- [[CBB Pro](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB)] Custom layout & style: With the ability to enqueue external JS/CSS and input custom JS/CSS, you can do anything with your blocks on frontend.
48
49	For dynamic data, we recommend using the [Meta Field Block](https://metafieldblock.com) plugin. It's the best way to display dynamic data.
50
51	=== Why choose CBB? ===
52
53	- It's fast, clean, flexible and code-free. It uses core blocks to build container blocks.
54	- It's bloat-free. It doesn’t come bundled with a ton of specific-use blocks like other multiple-feature plugins.
55	- It's easy to use. It adheres to Gutenberg and maintain the primary user experience of Gutenberg, so anyone familiar with the Block Editor is already familiar with CBB.
56	- Sites built with CBB are easier to maintain as most tasks are accomplished through the Block Editor. You don't need to know React to create complex blocks or maintain a code repository for them. You can also import/export them from/to other sites.
57
58	=== How does it help? ===
59
60	Below are some video tutorials that demonstrate how you can use this plugin to build your sites:
61
62	= Create a grid repeater block to display a grid of repeating content =
63
64	[youtube https://youtu.be/QKIPH5pmEWw]
65
66	= Create a banner slider for your site directly on the Editor =
67
68	[youtube https://youtu.be/EEk-kSa59VE]
69
70	= Create a custom blog page =
71
72	[youtube https://youtu.be/aHy3spQVBGc]
73
74	= Create a featured posts section =
75
76	[youtube https://youtu.be/paSXmpHU9K4]
77
78	= Create a glow-hover effect button variation =
79
80	[youtube https://youtu.be/rAWeQ2XLQJc]
81
82	=== More video tutorials ===
83
84	= Create custom layouts =
85
86	CBB includes five built-in layout blocks: Advanced Group, Grid, Carousel, Stack and Accordion. You can use them or build your custom layout blocks easily.
87
88	Watch the video tutorial to create a simple responsive grid using the built-in Grid block.
89
90	[youtube https://www.youtube.com/watch?v=awSC09tTnS8]
91
92	[Create a similar layout by creating a custom grid block](https://youtu.be/mICLfKkF6tU).
93
94	Watch the video tutorial to create a banner slider using the built-in Carousel block.
95
96	[youtube https://www.youtube.com/watch?v=Eh3kX-9_mDg]
97
98	Watch the video tutorial to create a FAQ section using the built-in Accordion block.
99
100	[youtube https://www.youtube.com/watch?v=YA4-duNF_w4]
101
102	= Create popup, off-canvas, popover, and toggle content =
103
104	With the toggle content feature, you can build a popup, off-canvas, popover, and toggle content easily and you can put anything in there.
105
106	Watch the step-by-step video tutorial to create modal, off-canvas content.
107
108	[youtube https://youtu.be/y31TAKHZOD0]
109
110	[Create a responsive header with hamburger menu and search bar toggle](https://youtu.be/E4usfCydR7U).
111	[Create a notification bar](https://youtu.be/g_KOCqvU0Ps).
112	[Create a video popup](https://youtu.be/52jD9eeBJ78).
113	[Create a cookie popup](https://youtu.be/UEh_Da9Sozs).
114	[Create an off-canvas content](https://youtu.be/YnUt-zQXnCU).
115
116	= Enhance the Query Loop and other blocks =
117
118	CBB provides a bunch of advanced features to add style to custom blocks like responsive width, height, spacing, border, box-shadow, transform, alignments etc. And by wrapping around other blocks, you can add those features to other blocks as well.
119
120	How to build a magazine layout grid with just one Query Loop block
121
122	[youtube https://youtu.be/Q4LP68Dh_Pc]
123
124	[Create a banner slider using the Query Loop block](https://youtu.be/bcK_k3IfW8g).
125	[Create a carousel of posts using the Query Loop block](https://www.youtube.com/watch?v=i8d8Pha921c).
126	[Create a blog layout with overlay style using the Query Loop block](https://youtu.be/YQHrf4xFctg).
127
128	= Create block variations, block styles, and block patterns =
129
130	CBB helps you create custom variations, styles, and patterns directly in the Block Editor without using a code editor.
131
132	[Create variations and styles for the core image block](https://youtu.be/BAY8_evbyL0).
133	[Create variations for any block](https://youtu.be/caiY-YZT7ZY).
134	[Create patterns](https://youtu.be/gfSNwcAb-xc).
135
136	= Google Fonts =
137
138	This feature does a really simple job, it loads a font for headings text and another for the body text from more than 1000+ Google Fonts easily with a few clicks. If you are worried about GDPR compliance, there is an option to load fonts from [Bunny Fonts](https://fonts.bunny.net/) instead of [Google Fonts](https://fonts.google.com/).
139
140	[How to use Google Fonts and be GDPR compliant](https://www.youtube.com/watch?v=rhd4SEKUcHU).
141
142	=== Which theme should I use with this plugin? ===
143	It is compatible with all Gutenberg-ready themes, but our recommended themes are default themes such as [Twenty Twenty Four](https://wordpress.org/themes/twentytwentyfour/), [Twenty Twenty Five](https://wordpress.org/themes/twentytwentyfive/), [Twenty Twenty Three](https://wordpress.org/themes/twentytwentythree/), [Twenty Twenty Two](https://wordpress.org/themes/twentytwentytwo/), or [Astra](https://wordpress.org/themes/astra/) theme.
144
145	=== How does it work with other blocks/plugins? ===
146	This plugin works with all third-party blocks but we recommend using single-block plugins for lightweight and performance. We also develop several single block plugins, that work great with this plugin, please see them in the below section.
147
148	=== Design library ===
149
150	We have already included a library of block patterns for you to quickly use or customize to fit your design. There is a popup inserter in the block editor for you to find and insert patterns with a few clicks.
151
152	[How to use the pattern inserter popup](https://youtu.be/UTrZSBvkzj0).
153
154	Browse the [Design Library](https://boldpatterns.net?utm_source=wp.org&utm_campaign=readme&utm_medium=link&utm_content=CBB) to see what the plugin can do for you.
155
156	=== Block and Variation library ===
157
158	Besides the pattern library, we have built an external library of content blocks and common block variations. All of the blocks/variations in this library have been created by CBB directly in the Block Editor. With a few clicks, you can easily import blocks or variations into your site. You use them directly or customize or learn from them.
159
160	Watch some video tutorials to learn how to use the library:
161
162	[Import the particles background block](https://youtu.be/BVvImhhZma4).
163	[Import the basic header block](https://youtu.be/hQBItwIu_90).
164	[Import the Query Loop variations](https://youtu.be/UpN9bdvs7Rs).
165	[Import the arrow buttons](https://youtu.be/U-e6wbFGiYg).
166
167	=== Learn CBB ===
168
169	Check out the documentation at [contentblocksbuilder.com](https://contentblocksbuilder.com/documentation?utm_source=wp.org&utm_campaign=readme&utm_medium=link&utm_content=CBB).
170	[Watch all tutorials on Youtube](https://www.youtube.com/@boldblocks/videos).
171	We're still recording video tutorials, so please [subscribe to our YouTube channel](https://www.youtube.com/channel/UCB7Y3mlCEKHVM-RCZaTkR1g?sub_confirmation=1) to get a notification when new videos are released.
172
173	=== Pro version ===
174
175	In short, the professional version adds following advanced features to your content such as:
176
177	- Custom CSS: Adjusts layout and style easily right in the inspector settings.
178	- Premium background effects: Includes parallax, infinite scrolling, and zooming effect to background image.
179	- Premium carousel features: Adds entrance animations, advanced effects, an effect builder, customized pagination, navigation, etc.
180	- Premium toggle content features: Enhancements for modal, off-canvas, and popover content with custom entrance animations, delay time, and closed state saving.
181	- Premium sticky content features: Detects stuck state and adds the ability to make blocks sticky only on scrolling up.
182	- Enqueue external JS/CSS and add custom JS/CSS to blocks.
183	- Add custom CSS to variations.
184	- Reveal animations: Adds stunning effects to blocks when they first appear in the viewport.
185
186	Watch more video tutorials to see how the Pro version can help you build advanced features for your sites:
187
188	[Create a sticky header](https://youtu.be/KEryi1y1UZ4).
189	[Create a custom block for the image zooming effect like Medium using an external script](https://youtu.be/WgHuo6jwyN8).
190	[Create a page title bar with a parallax background effect](https://youtu.be/0g1SLTq-lQ4).
191	[How to create an animated heading block](https://youtu.be/RfPPTg93WcQ).
192	[How to create a Back To Top block](https://youtu.be/0aTKpeTvgUY).
193	[How to create an image compare block](https://youtu.be/1tmIWXHv4gE).
194	[Create the infinite scrolling background effect](https://youtu.be/mBleA20caGo)
195	[Create the parallax background effect](https://youtu.be/nDpeQbpu50s)
196
197	[Go premium](https://contentblocksbuilder.com/pro/?utm_source=wp.org&utm_campaign=CBB+Upgrade&utm_medium=link&utm_content=CBB) to unlock advanced features with CBB Pro.
198
199	If this plugin is useful for you, please do a quick review and [rate it](https://wordpress.org/support/plugin/content-blocks-builder/reviews/#new-post) on WordPress.org to help us spread the word. I would very much appreciate it.
200
201	=== Other plugins ===
202
203	Please check out my other plugins if you're interested:
204
205	- [Meta Field Block](https://wordpress.org/plugins/display-a-meta-field-as-block) - A block to display custom fields as blocks on the front end. It supports custom fields for posts, terms, users, and setting fields. It can also be used in the Query Loop block.
206	- [SVG Block](https://wordpress.org/plugins/svg-block) - A block to display SVG images as blocks. Useful for images, icons, dividers, and buttons. It allows you to upload SVG images and load them into the icon library.
207	- [Icon separator](https://wordpress.org/plugins/icon-separator) - A tiny block just like the core/separator block but with the ability to add an icon.
208	- [Breadcrumb Block](https://wordpress.org/plugins/breadcrumb-block) - A simple breadcrumb trail block that supports JSON-LD structured data and is compatible with WooCommerce.
209	- [Block Enhancements](https://wordpress.org/plugins/block-enhancements) - Adds practical features to blocks like icons, box shadows, transforms, etc.
210	- [Counting Number Block](https://wordpress.org/plugins/counting-number-block) - A block to display numbers with a counting effect
211	- [Better YouTube Embed Block](https://wordpress.org/plugins/better-youtube-embed-block) - A block to solve the performance issue with embedded YouTube videos. It can also embed multiple videos and playlists.
212
213	The plugin is developed using @wordpress/scripts.
214
215	== Installation ==
216
217	= How to install it from wordpress.org =
218
219	Please see the video tutorial to install it from your site dashboard:
220
221	[youtube https://www.youtube.com/watch?v=wMTN0WpapPw]
222
223	= How to install it manually =
224
225	1. Upload the plugin files to the `/wp-content/plugins/content-blocks-builder` directory, or install the plugin through the WordPress plugins screen directly.
226	1. Activate the plugin through the 'Plugins' screen in WordPress
227
228	== Frequently Asked Questions ==
229
230	= Why do you need this plugin? =
231
232	To change the way of creating sites with WordPress from the legacy Classic Editor to the new Gutenberg Block Editor.
233
234	= Who needs this plugin? =
235
236	This plugin is made for developers or designers but anyone familiar with the Block Editor can use it.
237
238	= Is there a built-in design library? =
239
240	Yes, there is a library of production-ready block patterns.
241
242	= Is this another block library? =
243
244	No. It's like a tool to create custom layouts for core or third-party blocks without coding. However, it provides five custom block types: Grid, Carousel, Stack, Accordion and Advanced group.
245	Besides the five above block types, we have built an external library of content blocks and common block variations. You can easily import and use them in the plugin.
246
247	= Which themes does it support?
248
249	It is compatible with all block-based themes and some popular classic themes like Astra, but our recommended themes are default themes such as [Twenty Twenty Four](https://wordpress.org/themes/twentytwentyfour/), [Twenty Twenty Five](https://wordpress.org/themes/twentytwentyfive/), [Twenty Twenty-Three](https://wordpress.org/themes/twentytwentythree/), [Twenty Twenty-Two](https://wordpress.org/themes/twentytwentytwo/), and [Astra](https://wordpress.org/themes/astra/) theme. If you find it doesn't work with your theme, please let us know. We'll work on it.
250
251	== Screenshots ==
252
253	1. Block list screen
254
255	2. Block edit screen
256
257	3. Register block: synced overrides, template lock, description, CSS class, block icon
258
259	4. Register block: extended supports, variations
260
261	5. Register block: parent, ancestor, allowed, transformable, hidden, hide on frontend, enable repeater, scripts, stylesheets
262
263	6. Register repeater block: layout, title, description, CSS class, block icon
264
265	7. Register repeater block: extended supports, variations, limit child blocks
266
267	8. Carousel layout settings
268
269	9. Grid layout settings
270
271	10. Accordion layout settings
272
273	11. Toggle content settings
274
275	12. Sticky content settings
276
277	13. Background settings
278
279	14. Block library
280
281	15. Variation list screen
282
283	16. Variation edit screen
284
285	17. Register variation
286
287	18. Variation library
288
289	19. Pattern inserter popup
290
291	20. General settings
292
293	21. Typography settings
294
295	22. Import export settings
296
297	23. Developer settings
298
299	== Upgrade Notice ==
300
301	== Changelog ==
302
303	= 2.7.8 =
304	Release Date - 27 January 2025
305
306	* Improved - Revamp the UI of the edit block screen
307	* Improved - Changed the logic to display the enable variation picker setting for blocks
308	* Added - Added 'childBlockSelector' to the generators of the code editor when editting a repeater block.
309	* Improved - JavaScript linting for the code editor.
310	* Improved - Allowed changing attributes of content-only locking blocks when editing their variations.
311	* Improved - Variation endpoint API for better security
312	* Fixed - Fixed the issue where background block toolbar settings were not showing up in content-only locking.
313	* Updated - Freemius SDK 2.11.0
314
315	[View all changelog](https://contentblocksbuilder.com/changelog?utm_source=wp.org&utm_campaign=readme&utm_medium=link&utm_content=Changelog)
316