-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
381 lines (315 loc) · 16.1 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
=== Advanced Sidebar Menu ===
Contributors: Mat Lipe, onpointplugins
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=paypal%40onpointplugins%2ecom&lc=US&item_name=Advanced%20Sidebar%20Menu&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest
Tags: menus, page menus, category menus, sidebars, hierarchy
Requires at least: 6.2.0
Tested up to: 6.7.1
Requires PHP: 7.4.0
Stable tag: 9.6.3
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Fully automatic sidebar menus.
== Description ==
<h3>Fully automatic sidebar menus.</h3>
Uses the parent/child relationship of your pages or categories to generate menus based on the current section of your site. Assign a page or category to a parent and Advanced Sidebar Menu will do the rest for you.
Keeps the menu clean and usable. Only related items display, so you don't have to worry about keeping a custom menu up to date or displaying links to items that don't belong.
Blocks are available to display menus where you need them. Look for the "Advanced Sidebar - Pages" block, or the "Advanced Sidebar - Categories" block. Widgets are also available for page builders or sites using classic widgets.
<h3>Features</h3>
* Page and Category menu Gutenberg blocks.
* Page and Category menu widgets.
* Option to display or not display the highest level parent page or category.
* Option to display the menu when there is only the highest level parent.
* Ability to order pages by (date, title, page order).
* Exclude pages or categories by entering a comma separated list of ids.
* Option to always display child pages or categories.
* Option to select the levels of pages or categories to display when always display child is used.
* Option to display or not display categories on single posts.
* Ability to display each single post's category in a new widget/block or in same list.
<h3>Page Menu Options</h3>
* Display the highest level parent page.
* Display menu when there is only the parent page.
* Order pages by (date, title, page order).
* Exclude pages.
* Always display child Pages.
* Levels of child pages to display when always display child pages is checked.
<h3>Category Menu Options</h3>
* Display the highest level parent category.
* Display menu when there is only the parent category.
* Display categories on single posts.
* Display each single post's category in a new widget/block or in same list.
* Exclude categories.
* Always display child categories.
* Levels of Categories to display when always display child categories is checked.
<h3>Included Language Translations</h3>
* English (en_US).
* French (fr_FR).
* German (de_DE).
* Spanish (es_ES).
<h3>Documentation</h3>
The official documentation for the plugin <a target="_blank" href="https://onpointplugins.com/advanced-sidebar-menu/">may be found here</a>.
<h3>Developers</h3>
Developer docs <a target="_blank" href="https://onpointplugins.com/advanced-sidebar-menu/developer-docs/">may be found here</a>.
<h3>Contribute</h3>
Send pull requests via the <a target="_blank" href="https://github.com/lipemat/advanced-sidebar-menu">GitHub Repo</a>
<h3>Go PRO</h3>
Our <a href="https://onpointplugins.com/product/advanced-sidebar-menu-pro/?utm_source=readme&utm_campaign=gopro&utm_medium=dot-org">PRO version</a> brings additional functionality to this plugin. Check out [the demo](https://onpointplugins.com/advanced-sidebar-menu/advanced-sidebar-pro-demo/?utm_source=readme&utm_campaign=demo&utm_medium=dot-org) to see if the PRO version is useful for you.
* Navigation menu widget.
* Navigation menu Gutenberg block.
* Ability to customize each page or navigation menu item link's text.
* Click-and-drag styling for page, category, and navigation menus.
* Styling options for links including color, background color, size, hover, and font weight.
* Styling options for different levels of links.
* Styling options for the current page or category.
* Styling options for the parent of the current page or category.
* Blocked styling options including borders, border width, and border colors.
* Option to choose from 7 bullet styles or no bullets.
* Accordion menu support for pages, categories, and navigation menus.
* Accordion icon style and color selection.
* Accordion option to keep all sections closed until clicked.
* Accordion option to include highest level parent in accordion.
* Accordion option to use links for open/close.
* Ability to exclude a page from all menus using a simple checkbox.
* Link ordering for the category menus.
* Number of levels of pages to show when "always display child pages" is not checked.
* Ability to select and display custom post types.
* Ability to select and display custom taxonomies.
* Ability to display category post counts.
* Exclude pages or categories using intuitive search and select. **NEW**
* Option to display only the current page's parents, grandparents, and children.
* Option to display child page siblings when on a child page (with or without grandchildren available).
* Ability to display the menu everywhere the widget area is used (including homepage if applicable).
* Ability to select the highest level parent page/category.
* Ability to select which levels of categories assigned posts will display under.
* Ability to display assigned posts or custom post types under categories or taxonomies.
* Ability to limit the number of posts or custom post types to display under categories.
* Support for custom navigation menus from Appearance -> Menus.
* Ability to display the current navigation menu item's parents and children only.
* Option to display the top-level navigation menu items when there are no child items or not viewing a menu item.
* Priority support with access to members only support area.
== Installation ==
Use the standard WordPress plugins search and install.
Manual Installation
1. Upload the `advanced-sidebar-menu` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Drag the "Advanced Sidebar - Pages" widget, or the "Advanced Sidebar - Categories" widget into a sidebar.
4. Use the block inserter to insert the "Advanced Sidebar - Pages" block, or the "Advanced Sidebar - Categories" block into Gutenberg content.
== Screenshots ==
1. Page widget options.
2. Category widget options.
3. Example of a page menu using the 2017 theme and default styles.
4. Example of a category menu ordered by title using the 2017 theme and default styles.
== Frequently Asked Questions ==
= The menu won't show up?
The menu in this plugin are smart enough to not show up on pages or categories where the only thing that would display is the title. While it may appear like the menu is broken, it is actually doing what it is intended to do.
The most common causes for this confusion come from one of these reasons:
1. The incorrect menu was selected. Categories have their own widget/block as pages have their own widget/block.
2. "Display the highest level parent page" or "Display the highest level parent category" is not checked.
3. The Pages menu is currently not being viewed on a page.
4. The Categories menu is not currently being view on a category.
= How do I change the styling of the current page? =
You may add CSS to your theme's style.css to change the way the menu looks.
For example the following CSS would:
1. Remove the dot to the left of the menu item.
2. Change the link color.
3. Add a background on hover.
<code>
.advanced-sidebar-menu li.current-menu-item a {
color: black;
}
.advanced-sidebar-menu li.current-menu-item {
list-style-type: none !important;
}
.advanced-sidebar-menu li.current-menu-item > a:hover {
background: teal;
}
</code>
To style your menu without using any code <a href="https://onpointplugins.com/product/advanced-sidebar-menu-pro/" target="_blank">upgrade to PRO</a>.
= How do you get the categories to display on single post pages? =
The Categories Menu widget/block contains a "Display categories on single posts" checkbox, which will display the category menus based on the categories the current post is assigned to.
= Does the menu change for each page you are on? =
Yes. Based on whatever page, post or category you are on, the menu will change automatically to display the current parents and children.
== Changelog ==
= 9.6.3 =
* Introduced `advanced-sidebar-menu.blocks.preview.attributes` filter.
* Improved security of node packages.
* Improved deployment workflow.
* Tested to WordPress Core 6.7.1.
= 9.6.2 =
* Improved block style handling during previews.
* Disabled HTML editor for blocks.
* Introduced `is_server_side_render` helper method on block abstract.
* Improved isolation of passing block attributes to widget arguments.
* Fixed double up of block shadow in previews.
* Tested to WordPress Core 6.7.0.
= 9.6.1 =
* Introduce JEST unit testings for the basic version.
* Improved the automated testing suite.
* Improved deployment workflows.
* Fixed sourcemap generation on production builds.
* Tested to WordPress Core 6.6.2.
= 9.6.0 =
* Introduced `Widget/WidgtId` and `Widget/WithWidgetId` interfaces.
* Introduced `Widget/WidgetIdAccess` and `Widget/Checbox` traits.
* Improved debug handling in the browser.
* Introduced `advancedSidebarMenuDebug` helper function.
* Added support for PHP based translations.
* Fixed 'current-menu-ancestor' CSS class on category menus.
* Dropped support for PHP 7.2 in favor of 7.4+.
* Dropped support for React 17 in favor of 18+.
* Bumped required PRO version to 9.4.0.
* Bumped minimum required WordPress version to 6.2.0.
* Tested to WordPress Core 6.6.0.
= 9.5.2 =
* Provided unique HTML ids for category widgets with multiple top level categories.
* Continued work on converting the `Menu_Abstract` to an interface.
* Fixed click handling of menu previews in the block editor.
* Fixed fatal error when `is_plugin_active` is not available.
* Implemented PHPStan array shapes for block classes.
* Improved falsey conditions in the `Utils::is_empty` method.
* Officially added support for PHP 8.3.
* Tested to WordPress Core 6.5.3.
= 9.5.1 =
* Improved the plugin readme.
* Improved the translation headers.
* Improved the `List_Pages` cache.
* Added support to live previews using a playground blueprint.
* Tested to WordPress Core 6.5.0.
= 9.5.0 =
* Introduced `is_truthy` utility method.
* Introduced `get_post_type_label` utility method.
* Introduced `is_empty` utility method.
* Introduced `Menu` interface and began promoting `Menu_Abstract` to it.
* Introduced `Utils_Interface` to guarantee the existence of shared methods.
* Included classic editor state in debug information.
* Fixed the missing dashicons shown in the Preview component inside iframes.
* Fixed PHPCS minimum_wp_version config.
* Switched widget classes to trait/interface based structure.
* Introduced full array shapes for widget settings.
* Improved default widget settings.
* Prevented conflicts with theme styles and widget fields.
* Fixed excluding of child items if the top level parent is excluded.
* Converted deprecated block registering args to WordPress 6.1 version.
= 9.4.3 =
* Updated all block's api version to 3.
* Updated Node to version 20.
* Updated Yarn to version 4.
* Tested to WordPress Core 6.4.3.
* Required PRO version 9.2.0+.
= 9.4.2 =
* Fixed translation loading in blocks.
* Improved CSS and JS linting.
* Introduced 'advanced-sidebar-menu/block-wrapper-attributes' filter.
* Fully support PHP 8.2.
= 9.4.1 =
* Dropped support for PHP 7.0 in favor of 7.2.
* Bumped minimum supported WordPress version to 6.0.0.
* Improved block preview link handling.
* Required PRO version 9.1.8+.
= 9.3.4 =
* Passed block attributes and supports to JavaScript as well as PHP.
* Fixed issues with block previews in WordPress 6.4.
* Fixed issues with widget transformations in WordPress 6.4.
* Improved styles of legacy widget's info panel.
* Updated PHPStan level to 8 and fixed all warnings.
= 9.3.3 =
* Fixed issue with blocks loading in WordPress 6.4.
* Tested to WordPress 6.4.1.
= 9.3.2 =
* Fixed deployignore configurations.
= 9.3.1 =
* Improved select input styles in widget settings.
* Introduced 'advanced-sidebar-menu/scripts/admin-scripts' action.
* Aligned supported browsers with WordPress core.
* Updated the Node to version 18.
* Fixed all ESLint and Stylelint notices.
* Loosely a requirement for PRO version 9.3.0.
= 9.3.0 =
* Modernized legacy widget JS and CSS into the Webpack structure.
* Reduce bundle size of admin resources.
* Renamed CSS files with the "advanced-sidebar-menu" prefix.
* Added support for collapsing info panels on page builders and theme customizers.
* Updated the block `apiVersion` to "3".
* Tested to WordPress 6.3.2.
* Greatly improved widgets styles in Beaver Builder and Elementor.
= 9.2.1 =
* Introduced transform legacy widgets to blocks prompts.
* Moved configurations to the root of the plugin and general modernization.
* Made "Go PRO" callouts more tasteful and less intrusive.
* Improved styles of the info panels in widgets and blocks.
* Improved styles of buttons and fields in Beaver Builder.
* Updated WP-PHPCS to version 3 and fixed all warnings.
= 9.1.0 =
* Separated the exclude pages/categories field into a filterable component.
* Updated links to various documentation.
* Added default values to most block attributes.
* Updated block attribute TS definitions to accurately reflect default values.
* Updated TS to version 5.
* Updated PHPCS scanning to version 3 of WP PHPCS standards.
* Loosely update the minimum requirement for PRO to version 9.2.0.
= 9.0.11 =
* Changed default limit of child pages to 200 instead of 100.
* Simplified and improved the `List_Pages::parse_args` method.
* Added links to documentation in the plugins list.
* Tested to WordPress core 6.3.1.
= 9.0.10 =
* Fixed compatibility with Jetpack widget visibility.
* Included the screen and section information in ErrorBoundary data.
* Improved static analysis testing.
* Improved unit testing for WordPress 5.8.
* Tested to WordPress core 6.3.0.
= 9.0.9 =
* Fixed conflict with [Stackable WordPress plugin](https://wordpress.org/plugins/stackable-ultimate-gutenberg-blocks/) in the theme customizer.
* Improved block script reliability.
* Improved handling of Elementor previews.
* Improved error boundary informational messages.
* Removed conflicts with POST method requests.
= 9.0.8 =
* Disabled legacy widgets by default [see docs]( https://onpointplugins.com/advanced-sidebar-menu/advanced-sidebar-menu-gutenberg-blocks/#enable-widgets).
* Update browser list support.
* Improved the widget/block transformation logic and types.
* Removed dangling WordPress version < 5.6 requirements.
* Tested to WordPress core 6.2.2.
= 9.0.7 =
* Fixed `data-level` on category menus larger than 3 levels.
* Included classic widgets flag in debug information.
* Required PRO version 9.1.2+.
= 9.0.6 =
* Improved extendability by removing all `private` access modifiers.
* Fully support PHP 8.1.
* Tested to WordPress Core 6.2.0.
= 9.0.5 =
* Switched to static uses of class constants to improve extendability.
* Switched to full namespaced constants.
* Improved PHPCS definitions.
* Improved translations.
* Included help information for the category widget exclude settings.
= 9.0.4 =
* Added "current-menu-ancestor" CSS class to Pages and Categories menus.
* Introduced "advanced-sidebar-page" CSS class to Pages menus.
* Tested to WordPress Core 6.1.1.
= 9.0.3 =
* Fixed issue with styles not loading in Elementor.
* Tested to WordPress Core 6.0.2.
= 9.0.2 =
* Moved `advanced-sidebar-menu` CSS class to block widget wraps.
* Introduced `isScreen` helper to make screen conditionals cleaner.
* Included "Display each single post's categories" option on the customizer screen.
* Included PHP version in debug information.
* Improved readme.
= 9.0.0 =
<a href="https://onpointplugins.com/advanced-sidebar-gutenberg-blocks/">Full release notes</a>.
* Introduced Gutenberg blocks.
* Improved translations.
* Improved Elementor support.
* Removed all deprecated functionality.
* Required PRO version 9.0.0+.
* Required WordPress Core 5.8.0+.
* Drop support for PHP 5.6 if favor of PHP 7.0+.
* Numerous bug fixes.
== Upgrade Notice ==
= 9.3.4 =
Update to support WordPress 6.4.
= 9.1.0 =
Update to support PRO version 9.2.0.
= 9.0.1 =
Introducing <a href="https://onpointplugins.com/advanced-sidebar-menu/advanced-sidebar-menu-gutenberg-blocks/">Gutenberg blocks</a>.