Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FileTree Diagram (PR #5665) #6231

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
Open

Conversation

gancena
Copy link

@gancena gancena commented Jan 27, 2025

📑 Summary

This PR is a fork and update of @Vikrantpalle's original PR: #5665 (comment)

This PR introduces a new diagram named FileTree which displays hierarchical directory-like structures.

Resolves #2645

📏 Design Decisions

The features of the diagram focus on user flexibility and ease of use.

  • Simple Syntax: The structure of the tree depends only on the indentation of rows.
  • User Flexibility: Users have the flexibility to change most aspects of the diagram including font size, padding, line thickness, etc.
  • Dynamic Layout: The rows and lines are laid out dynamically based on the changing size of labels.

📋 Tasks

Make sure you

  • [ /] 📖 have read the contribution guidelines
  • [ /] 💻 have added necessary unit/e2e tests.
  • [ /] 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • [ /] 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Jan 27, 2025

⚠️ No Changeset found

Latest commit: 87144e1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 87144e1
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6797f8d85241bc0008b6d8ee
😎 Deploy Preview https://deploy-preview-6231--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Folder structure Diagram
2 participants