collection of web components and customizations used at Boston University Libraries
This repository contains web assets of Boston University Libraries that are used across a variety of our sites and demonstrated in isolation via storybook.
These take a number of forms...
sites/assets/src/src/_helpers/)...and depend on a number of technologies...
lit-element library for more advanced functionality...towards the end of...
Install dependencies via node package manager
$ brew install node
$ git clone https://github.com/bulib/bulib-wc.git
$ cd bulib-wc
$ npm install
note: additional steps and troublshooting can be found in the wiki
running the following will open up a new tab in your browser at localhost:9001/?path=/story/, and watch for changes.
$ npm run start
you can make changes to existing elements and see them in that running server by navigating to that component in the sidebar.
to create a new one, make a new entry in /docs/index.stories.js based off of the existing ones
to build a bundle, run the following, noting that the default will use the rollup.config.js.
$ npm run build
or a bundle with open-wc version (with codesplitting), run:
$ npm run build:owc
you can also build a static copy of the static docs site via:
$ npm run build:storybook
We expect to continue to manage versioning this repository with npm, but we want to make sure that updates are synchronized (e.g. our demo site and github tags are all in sync), so we've made a script to help assist with that
$ npm run deploy
we use semantic versioning (semver), and assume by default that you're publishing a patch. If you'd like to
specify the level of change you're making (e.g. you want to mark a significant addition in functionality or a milestone in the project)
you can specify major or minor as well:
$ npm run deploy [patch, major, minor]
Sometimes you may just want to update the storybook to demonstrate a change before you're finished developing (without publishing a new package for it on NPM) to verify the implementation is correct or desired functionality with a third party (like your advisor). You can update only the storybook by running the following:
$ npm run deploy:storybook
We consume the published package over two main CDNs (unkpg, jsdelivr),
versioned and deployed using npm and added to each platform via a series of <script> and <link> tags stored in the <head>.
All the web components are imported together from a single index.js file. Unpkg does some mapping here to chain together a
number of calls that leverage the module specification. This does the work that a bundler would do, but without the
extra build step, transpilation, etc.
note: one can import a specific version (e.g. bulib-wc@0.0.92) or the most recently published one (bulib@latest)
<!-- load web components -->
<script src="https://cdn.jsdelivr.net/npm/@webcomponents/webcomponentsjs@2.1.3/webcomponents-loader.min.js"></script>
<script src="https://unpkg.com/bulib-wc@0.1.0/src/index.js?module" type="module"></script>
For the css, we have both a shared "bundle" (created via scripts/bundle_css.sh), and site-specific forms for each site_name.
These are imported via <link> like the following. Further customizations for each site are in sites/**.css.
NOTE: if you don't include the bundle.min.css stylesheet as well as the index.js?module in a given site, the styling for many components will be broken
<!-- styling -->
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/bulib-wc@0.1.0/dist/bundle.min.css">
<!--link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/bulib-wc@latest/dist/{site_name}.css"-->
An example of what all to include in each site's <head> is also available at sites/shared.html.
FAQs
collection of web components and styles used at Boston University Libraries
The npm package bulib-wc receives a total of 10,915 weekly downloads. As such, bulib-wc popularity was classified as popular.
We found that bulib-wc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.