README

PHP for Mermaid.js mindmaps.

For license information see the LICENSE file.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist beastbytes/mermaid-mindmap

or add

"beastbytes/mermaid-mindmap": "{{versionConstraint}}"

to the require section of your composer.json.

Usage

• Create and configure a root Node instance
• Add child nodes to the root node
• Nodes can be nested to any level
• Create a Mindmap instance using Mermaid::create()
• Add the root node to the Mindmap instance
• Render the Mindmap instance

API

Mindmap

Represents a Mindmap diagram.

withComment

Returns a new instance of Mindmap with a comment.

Parameters

withRootNode

Returns a new instance of Mindmap with a root node.

Parameters

Node

Represents a node in Mindmap diagram.

__construct()

Returns a new instance of Node.

Parameters

addNode()

Returns a new instance of Node with the node(s) added to the existing child nodes.

Parameters

withComment()

Returns a new instance of Node with a comment.

Parameters

withIcon()

Returns a new instance of Node with an icon. The icon pack must be available on the page rendering the diagram.

Parameters

withNode()

Returns a new instance of Node with the child node(s).

Parameters

withStyleClass()

Returns a new instance of Node with the style class.

Parameters

withText()

Returns a new instance of Node with the node text.

If this method is not called, the node ID is used as the node text.

Parameters