@cerner/carbon-site-helpers

A set of helpers for Carbon Graphs Site

Usage no npm install needed!

<script type="module">
  import cernerCarbonSiteHelpers from 'https://cdn.skypack.dev/@cerner/carbon-site-helpers';
</script>

README

Carbon Site Helpers

Build Status npm latest version Cerner OSS License semantic-release

Repository containing helpers for Carbon Graphs Site. Uses Material UI and React.

Dependencies

  • @material-ui/core
  • @material-ui/icons
  • @material-ui/styles
  • react
  • react-dom
  • react-router
  • react-router-dom
  • prop-types
  • classnames
  • dompurify
  • axios
  • marked
  • brace

Usage

import renderSiteApp from "@cerner/carbon-site-helpers";

const contentSourceCode = function(id) {
    document.querySelector(`#${id}`).innerHTML = "content/line/simple-line";
};
renderSiteApp(
    [
        {
            pathname: "/line",
            children: [
                {
                    pathname: "/line/simple-line",
                    title: "Simple Line Graph",
                    content: id => {
                        document.querySelector(`#${id}`).innerHTML =
                            "content/line/simple-line";
                    },
                    getCodeContent: () => contentSourceCode.toString()
                },
                {
                    pathname: "/line/timeseries",
                    content: id => {
                        document.querySelector(`#${id}`).innerHTML =
                            "content/line/timeseries";
                    }
                }
            ]
        }
    ],
    {
        gettingStartedLink: "#/line/simple-line",
        gitHubRepo: "https://github.com/MyRepo"
    }
);

LICENSE

Copyright 2017 - 2019 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.