The PERSCOM Widget offers a simple and effective way to integrate your PERSCOM.io data externally into various websites and content management systems.
By using a straightforward HTML code snippet, the widget can elegantly render and present your data in a non-intrusive manner. Further, the widget can be fully customized using CSS to seamlessly blend with your website's aesthetics.
<!-- Place this code where you want the widget to appear on your website. -->
<!-- Replace APIKEY with your actual API key. -->
<div id="perscom_widget_wrapper">
<script
id="perscom_widget"
data-apikey="APIKEY"
data-widget="roster"
data-dark="false"
src="https://widget.perscom.io/widget.js"
type="text/javascript"
></script>
</div>
A live version of the widget can be viewed here. This demo uses data straight from our demo organization available at https://demo.perscom.io.
Explore the variety of available widgets:
Visit our documentation here to get started.
Please see here for more details about contributing.
Navigate to the project directory and execute the following commands:
Launches the application in development mode.
Initiates a local web server serving widget.js
for local development.
Activates the test runner in interactive watch mode.
Compiles the application for production into the build
folder.
Compiles the widget for production into the dist
folder.
The compiled file will be named widget.js
.
Formats the source code of the application. Run before pull requests and repository pushes.
Executes ESLint to ensure source code adheres to best practices and syntax rules. Run before pull requests and repository pushes.