100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
{/* prettier-ignore-start */}
{/*
* Copyright 2025, OpenRemote Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: AGPL-3.0-or-later
*/}
{/* prettier-ignore-end */}
import { Title, Subtitle, Canvas, Markdown, ArgTypes } from "@storybook/addon-docs/blocks";
import { getCustomElements } from "./util.js";
import { DocsBadge } from "./elements.mdx";
export const ComponentDocs = (props) => {
// Load objects from the MDX props
const story = props?.story;
const options = props?.options;
if(!story) return (<i>Error: Could not find story.</i>)
if(!story.default?.component) return (<i>Error: Could not find tag name of the component. Please define in `story.meta.component`.</i>)
if(!story.default?.parameters?.docs?.subtitle) return (<i>Error: Could not find subtitle of the story. Please define in `story.meta.parameters.docs.subtitle`.</i>)
if(!story.packageJson) return (<i>Error: Could not find package.json of the story. Please export it inside the story file.</i>)
if(!props?.elementsjson) return (<i>Error: Could not find custom-elements.json specification of the story.</i>)
// Load custom elements from the story
const customElements = getCustomElements(story.default.component, props?.elementsjson);
if(!customElements) return (<i>Error: Could not parse custom-elements.json specification of the story.</i>)
return (
<>
<Title>{options.displayName || customElements.tagName || "Title"}</Title>
<Subtitle of={story}></Subtitle>
<div className="badge-section">
{story.packageJson && !options.hideNpm ? (<DocsBadge type="NPM" packageJson={story.packageJson} />) : null}
{story.packageJson && !options.hideLicense ? (<DocsBadge type="License" packageJson={story.packageJson} />) : null}
{story.packageJson && !options.hideDownloads ? (<DocsBadge type="Downloads" packageJson={story.packageJson} />) : null}
</div>
{/* Description of the component */}
{story.default?.parameters?.docs?.description || customElements.description
? <Markdown>{story.default?.parameters?.docs?.description ?? customElements.description}</Markdown>
: <i>Could not find description of the story. Please place a comment above the TypeScript class of the component.</i>
}
{/* Primary interactive example of this component */}
{story.Primary ? <Canvas of={story.Primary}/> : <i>Could not find story. Please define a story, and export it as "Primary".</i>}
{/* Examples section */}
{story.examples?.length ? <div id="examples-section">
{story?.examples.map((s, index) => <div key={("Example" + index)}>
<Markdown>{"### " + (s.parameters?.title ?? s.name ?? ("Example " + index))}</Markdown>
{s.parameters?.summary ? <Markdown>{s.parameters?.summary}</Markdown> : null}
<Canvas of={s}></Canvas>
</div>)}
</div> : null}
{/* Attributes & Properties section */}
<Markdown>## API Specification</Markdown>
<ArgTypes of={story}/>
</>
);
};