https://github.com/hugoabernier/react-diagram-webparts
A collection of web parts that make it easy to embed diagrams in SharePoint pages
https://github.com/hugoabernier/react-diagram-webparts
ace-editor flowchart markdown office365 sequence-diagram sharepoint sharepoint-framework spfx svg
Last synced: 8 months ago
JSON representation
A collection of web parts that make it easy to embed diagrams in SharePoint pages
- Host: GitHub
- URL: https://github.com/hugoabernier/react-diagram-webparts
- Owner: hugoabernier
- Created: 2019-02-09T01:55:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-11T18:04:17.000Z (almost 4 years ago)
- Last Synced: 2025-02-02T06:11:28.418Z (9 months ago)
- Topics: ace-editor, flowchart, markdown, office365, sequence-diagram, sharepoint, sharepoint-framework, spfx, svg
- Language: TypeScript
- Size: 57.7 MB
- Stars: 16
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# React Diagram Web Parts
## Summary
This solution contains a collection of web parts that make it easy
to embed various types of diagrams in pages.
### Flowchart
The Flowchart web part allows you to use simple text to create flowchart diagrams in a page.
It uses the [js-flowchart](https://github.com/adrai/flowchart.js) syntax to quickly create diagrams.
### Mermaid diagram
The Mermaid diagram web part allows you to use simple text to create flowcharts, gantt charts, and sequence diagrams and control their appearance.
It uses the [mermaidjs](https://mermaidjs.github.io/) syntax to create awesome diagrams.
### Sequence diagram
The Sequence diagram web part allows you to create sequence diagrams using simple text.
It uses the [js-sequence-diagrams](https://bramp.github.io/js-sequence-diagrams/) syntax to make creating sequence diagrams intuitive.
## Used SharePoint Framework Version
## Applies to
* [SharePoint Framework](https:/dev.office.com/sharepoint)
* [Office 365 tenant](https://dev.office.com/sharepoint/docs/spfx/set-up-your-development-environment)
## Solution
Solution|Author(s)
--------|---------
react-diagram-webparts | Hugo Bernier ([Tahoe Ninjas](http://tahoeninjas.blog), @bernierh)
## Version history
Version|Date|Comments
-------|----|--------
1.0|Feb 8, 2019|Initial release
1.1|Feb 12, 2019|Added Mermaid diagram web part.
1.2|Apr 16, 2019|Upgraded to SPFx 1.8
1.3|Apr 22, 2019|Upgraded to SPFx 1.8.1
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
---
## Minimal Path to Awesome
* Clone this repository
* in the command line run:
* `npm install`
* `gulp serve`
## Features
This Web Part illustrates the following concepts:
* Using [react-sequence-diagram](https://github.com/zfanta/react-sequence-diagram) in a SPFx web part (React component based on [js-sequence-diagrams](https://bramp.github.io/js-sequence-diagrams/))
* Using [react-simple-flowchart](https://github.com/alwinn1977/react-simple-flowchart) in a SPFx web part (React component based on [js-flowchart](https://github.com/adrai/flowchart.js))
* Using [mermaid](https://github.com/knsv/mermaid) in a SPFx web part.
* Converting a static SVG to a responsive SVG post-render
* Improving accessibility on a SVG post-render
* Creating a custom code editor property pane that allows custom code/syntax
* Using [react-ace](https://github.com/securingsincity/react-ace) to embed an Ace Editor for code editing and syntax highlighting
* Creating custom syntax highlighting for react-ace
* Creating a custom Markdown property pane control that renders a read-only version of Markdown text in a property pane
* Using [markdown-to-jsx](https://github.com/probablyup/markdown-to-jsx) to render Markdown in a web part
