1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-15 18:09:55 +00:00
TiddlyWiki5/plugins/tiddlywiki/menubar
Jeremy Ruston 5aa3646df5
Add plugin stability badges (#8198)
* Initial Commit

* Fix plugin library URL

* Need to set plugin library location for prerelease

* Styling tweaks

* Docs

* Add tests that the core plugins all have a valid stability field
2024-05-21 11:22:39 +01:00
..
items Fix indentation for tiddlers that set tv-config-toolbar-class (#8079) 2024-03-16 19:03:36 +00:00
overrides First commit of new Menu Bar plugin 2020-02-28 14:33:15 +00:00
config-breakpoint.tid First commit of new Menu Bar plugin 2020-02-28 14:33:15 +00:00
config-DefaultColourMappings.multids First commit of new Menu Bar plugin 2020-02-28 14:33:15 +00:00
config-MenuItemsVisibility.multids Menubar: Add an optional dropdown for the sidebar tabs 2020-03-14 12:55:11 +00:00
config-TableOfContentsTag.tid Make tag for menubar-contents dropdown configurable (#4983) 2020-11-06 16:26:44 +00:00
config.tid Make tag for menubar-contents dropdown configurable (#4983) 2020-11-06 16:26:44 +00:00
menu.tid Menu bar plugin: Hide menu bar in static renderings 2023-06-17 08:58:50 +01:00
plugin.info Add plugin stability badges (#8198) 2024-05-21 11:22:39 +01:00
readme.tid Menubar plugin: Add optional dropdown-position 2021-03-08 17:47:04 +00:00
styles.tid Remove menubar from print (#5273) 2020-12-13 11:37:07 +00:00
tags-MenuBar.tid First commit of new Menu Bar plugin 2020-02-28 14:33:15 +00:00

title: $:/plugins/tiddlywiki/menubar/readme

!! Introduction

This plugin provides a menu bar with the following features:

* Menu items take the form of simple text links, dropdowns, or entirely custom content
* Menu items can be individually enabled via the control panel
* Responds to reduced screen width by abbreviating the menu items to a "hamburger" dropdown

!! Menu Item Tiddlers

Menu items are tagged <<tag $:/tags/MenuBar>>. The following fields are used by this plugin:

|!Field Name |!Purpose |
|title |Each menu item must have a unique title (not shown to the user) |
|description |Description for use in listings |
|tags |Must contain `$:/tags/MenuBar` |
|caption |The text that is displayed for the menu item. Avoid links, using `~` to suppress CamelCase links if required |
|target |For simple link menu items specifies a tiddler title as the target of the link |
|is-dropdown |Set to `yes` to indicate a dropdown menu item |
|dropdown-position |Optional position for the dropdown (can be ''left'', ''above'', ''aboveleft'', ''aboveright'', ''right'', ''belowleft'', ''belowright'' or ''below'') |
|text |For dropdown menu items, specifies the body of the dropdown |
|custom-menu-content |Optional wikitext to be displayed in place of the caption |
|custom-menu-styles-wide |Optional string of styles to be applied to menu item when the menubar is wide |
|custom-menu-styles-narrow |Optional string of styles to be applied to menu item when the menubar is narrow |

Custom menu items should make sure that the clickable link or button is an immediate child, and not wrapped in another element.

Note that menu items can be pushed to the right of the menu bar setting the ''custom-menu-styles'' field to `float: right;`.