Table of Contents
- Getting Started
- Working on this library
Getting started
How to use the widget in any HTML page
-
We need to define where the widget is going to be rendered. In your page, add a div element where you want to render the app. Make sure the element has the id
attribute set.
<div id="timed-ticketing-container"></div>
-
We need to import the script and the base stylesheet. To do this, under the <head>
tag in your page add the following code:
<link href="https://unpkg.com/@halo-media/ts-timed-ticketing-widget@latest/dist/style.css" rel="stylesheet" />
<script src="https://unpkg.com/@halo-media/ts-timed-ticketing-widget@latest/dist/index.umd.js"></script>
-
Finally, we can configure and render the app. Add the following script right before the end of the body of your page
<script type="module">
const Checkout = window['ts-timed-ticketing-widget'];
const rootElement = document.getElementById(
'timed-ticketing-container',
);
if (rootElement && config) {
Checkout.render({
element: rootElement,
endpoint: '',
clientId: '',
siteId: '',
eventSlug: '',
square: {
appId: '',
locationId: '',
},
});
}
</script>
Test your config
You can test if you config works by trying to load it in the demo site here
Working on this library
Make sure you have Node.js v16 and NPM v8 or above installed on your machine.
The project uses ViteJS to generate the bundle and for the development server.
How to use the library while developing other projects
After cloning this repo, you need to link the library
-
Inside this repository, run npm run build
to make sure you are using the latest changes and then npm link
-
Go to the project where you want to use this library, and run npm link @halo-media/ts-timed-ticketing-widget
-
Build while listening for changes with: npm run build:watch
Thats all.
FAQ
Q: Why is React and ReactDOM marked as devDependencies in package.json?
A: This package is meant to be used as a library to build Checkouts. For that reason we use Vite's "library" mode which does not bundle React and ReactDOM. We still need them as npm dependency for development so we can avoid working exclusively with npm link
.