TAMU Library Components is an extension both on top of and perpendicular to Weaver Components. This either extends components, providing custom styles, or provides entirely new components.
TAMU Library Components may be installed by either referencing a CDN or by using NpmJs.
The latest pre-built package may be found in the TAMU Library Elements NpmJs Repository.
Using the npm command (from NpmJs), install this project as a dependency to an existing project:
npm install @wvr/tl-elements
The files tl-components.js and styles.css need to be available on some server.
See the Building section below for details on how to build these files.
The CSS file should be added as an HTML <link> element to the HTML <header> element, such as:
<html>
<head>
<link rel="stylesheet" type="text/css" href="https://localhost/styles.css">
</head>
</html>
The Javascript file should be added an HTML <script> element to the HTML <bottom> element at the very end, such as:
<html>
<body>
...
<script src="https://localhost/tl-components.js"></script>
</body>
</html>
To build this project use the npm command (from NpmJs).
This project can be built to run locally for development purposes be built to get the tl-components.js and styles.css files needed to run on a CDN.
More detailed documentation about the build process may be found via the referenced links in the Documentation section below.
The tl-components.js and the styles.css files are needed if intending to utilize this project via a CDN.
These files are built using the build command from within the project root directory:
cd tamu-library-components
npm run build
Once this has successfully completed the tl-components.js and styles.css files should be located under the dist/bundle/ sub-directory:
dist/bundle/styles.css
dist/bundle/tl-components.js
Building this for a NpmJs Package is the same as building this for a CDN.
These files are built using the build command from within the project root directory:
cd tamu-library-components
npm run build
When wanting to run against a locally built Weaver Components, the Verdaccio service in Weaver Components should be used. Follow the Weaver Components documentation to set this up.
Once Weaver Components is properly set up, the npm-local command can be used to fetch only the local Weaver Components from the Verdaccio service.
The npm install command will overwrite the local version which will result in loss of changes made by npm-local.
Once Weaver Components is properly setup, the build and even start commands may be performed.
npm install
npm run npm-local
npm run build
npm run start
Detailed documentation may be found:
Detailed reports may be found: