Titanium Elements

A collection of lightweight web components used by Leavitt Group Enterprises and partnering organizations.

Development

npm i
npm start

Contributions

Conventional Commits Required

The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.

TypeScript Required

Types enable JavaScript developers to use highly-productive development tools and practices like static checking and code refactoring when developing JavaScript applications.

Creating a new component

Create the component

• Copy an existing component
• Delete the CHANGELOG.md
• Update the package.json
  • Find and replace the old package name with the new package name
  • Change dependencies (keep tslib)
  • Reset version number to 1.0.0 (this is important)
• Delete lib and node_modules inside the new component folder
• Replace the copied component in src with your component
• Add a path to your component in the root level tsconfig.json
• Run npm start (npm install prior if you haven't ran it already)

Create the leavittbook story

See packages/leavittbook/CLAUDE.md for gallery conventions.

• Copy an existing leavittbook demo (e.g. packages/leavittbook/src/demos/leavitt-error-page-demo.ts) and rename it
• Update packages/leavittbook/src/my-app.ts
  • Add a page('/route', …) handler
  • Add a drawer <md-list-item href="…"> (label must match level1Text on the demo header)
  • Add a conditional render tag in <main-content>
• Add requires-auth on <story-header> if the demo calls api3

Important

• Publish to NPM after the PR has been approved but before it gets merged