/UMLWebWidget

A jQuery widget to display UML diagrams

Primary LanguageTypeScriptMIT LicenseMIT

CodeSmithy - UMLWebWidget

The UMLWebWidget project provides a jQuery widget to display UML diagrams in a web page.

Contents

  • dist: bundles ready to be used,
  • stylesheets: default stylesheets that can be used with the bundles in the dist directory.

Project Status

This project is in its development phase.

Many of the diagrams are ready to be used but it is likely that you will need to modify the code to suit your needs and creating diagrams is fairly cumbersome at the moment since there is no automatic layout.

Also documentation is currently lacking and mostly limited to the samples available in this repository.

Usage

There are 3 bundles in the dist directory:

  • codesmithy-umlwebwidget.js is the production bundle to display UML diagrams on a web page,
  • codesmithy-umlwebwidget.dev.js is the development version of the codesmithy-umlwebwidget.js bundle,
  • codesmithy-umlwebwidget.node.dev.js is targeted at Node.js and is used by the automated tests.

Support

For all questions about this project you can raise an issue on GitHub.

License

Copyright (c) 2017-2020 Xavier Leclercq

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Files not under the above license

We do include a few of the dependencies in the ThirdParty directory. Check out the https://github.com/CodeSmithyIDE/UMLWebWidget/blob/master/ThirdParty/README.md for the relevant licenses.