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

Fix TypeError in insertNode and Add Configurable Bar Width for Bar Charts #6117

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

Conversation

husainsaifuddin
Copy link

@husainsaifuddin husainsaifuddin commented Dec 7, 2024

📑 Fix Node Shape Validation and Add Configurable Bar Width Feature

This PR addresses two key issues:

Fix for Node Shape Validation (Issue #1234)
Resolved a TypeError: Cannot read properties of undefined (reading 'shape') when a node without a shape property is passed to the insertNode function.
Solution:
Added a validation check for the shape property before referencing it in rendering-elements/nodes.ts. The new logic ensures that node.shape is validated before usage, preventing uncaught exceptions and enhancing the robustness of the rendering process.

Configurable Bar Width for Bar Charts (Issue #5678)
Added support for customizable bar widths in bar charts, allowing users to define fixed widths or control spacing to let bars fill the available space.
Solution:
Implemented a new customBarWidth property in the BarPlot class. This provides flexibility for users to set specific bar widths or rely on dynamic calculations for default behavior.

Resolves #1234 and #5678

📏 Design Decisions

Implementation:

  • Added an optional customBarWidth parameter to the BarPlot constructor.
  • Updated bar width calculation in getDrawableElement() to prioritize customBarWidth.

Tests Added:

  • Unit tests to verify correct application of customBarWidth.

📋 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 Dec 7, 2024

⚠️ No Changeset found

Latest commit: f503ea7

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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 Dec 7, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit f503ea7
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/6754a4657ed0470008d3fb3d
😎 Deploy Preview https://deploy-preview-6117--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.

Copy link

pkg-pr-new bot commented Dec 7, 2024

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6117
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6117
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6117
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6117

commit: f503ea7

Copy link

argos-ci bot commented Dec 7, 2024

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ Auto-approved build (Review) 339 added, 339 removed, 4 failures Dec 7, 2024, 7:49 PM

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.

Refactor support for class diagram scaling
2 participants