npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bloomreach/hippo-theme

v5.0.2

Published

Hippo theme is a centralised library containing reusable components for Hippo-related projects.

Downloads

983

Readme

Hippo Theme

The Hippo theme is a centralised library containing reusable components for Hippo-related projects. You can use it to create clickable mockups or end-projects that need to be in line with the Hippo styling.

Development environment setup

Prerequisites

Installation

Run the commands below in the project root directory.

$ npm ci

Useful commands

Generate build

The build version is located in the dist directory.

$ npm run build

Run tests

The tests need to pass in order to build the demo.

$ npm test

Setup server

The browser will show the demo website which shows all available components for the theme.

$ npm start

Watch task for the Hippo theme during development

When working on end projects that use Hippo theme, sometimes changes need to be made to Hippo theme and you want to see the results right away. For this we can use npm link. First create a global link to the Hippo theme

$ npm link

On OSX, you may need super-user privileges to create this link. Assuming you have a watch task with livereload enabled running in your end project, you can use the npmlink_watch task to watch the Hippo theme files (running two live-reload watch tasks in parallel is not possible)

$ npm run npmlink_watch

Then in your end project run

$ npm link hippo-theme

When the link is no longer necessary, simply remove it on the project side with

$ npm uninstall hippo-theme

and in your global NPM library with

$ npm unlink

This, too, may require super-user privileges on OSX.

Deployment to NPM

$ npm publish

Development

Adding icons

To add an icon to the theme and use it in the CMS Java code, perform the following steps:

  • Add the .svg file to the src/images/icons folder
  • Ensure that there is a copyright header
  • Ensure that the icons does have color by setting 'fill="currentColor"' or 'stroke="currentColor"' where applicable
  • Add the icon to the demo page
  • Add the icon constant to the CMS project's Icon.java (api/src/main/java/org/hippoecm/frontend/skin/Icon.java)