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

@flourish/ui-styles

v6.0.0

Published

Flourish module for styling UI elements

Downloads

667

Readme

Flourish UI Styles

Style UI elements (like @flourish/controls) in Flourish templates.

How to install

npm install -s @flourish/ui-styles

Add one or more control style objects to your template state:

export var state = {
	controls_style: {},
	button_style: {},
	dropdown_style: {},
	slider_style: {},
}

Import settings for controls styling in your template.yml settings.

- property: controls_style
  import: "@flourish/ui-styles/controls-style"
- property: dropdown_style
  import: "@flourish/ui-styles/dropdown-style"
- property: button_style
  import: "@flourish/ui-styles/button-style"
- property: slider_style
  import: "@flourish/ui-styles/slider-style"

Basics

Initialise the styling outside any function or in a special init function:

import { createGeneralControlsStyle, createButtonStyle, createDropdownStyle, createSliderStyle } from "@flourish/ui-styles";
var controlsStyle = createGeneralControlsStyle(state.controls_style, ".fl-control"),
    buttonStyle = createButtonStyle(state.button_style, ".fl-control-buttons"),
    dropdownStyle = createDropdownStyle(state.dropdown_style, ".fl-control-dropdown");
	sliderStyle = createSliderStyle(state.slider_style, ".fl-control-slider");

The init function takes the state object as a first argument. The second argument is the target container for styling. If you are using @flourish/controls you can just use the selectors in the code above.

If you're using this on custom HTML, make sure to target the direct parent container of your controls, and make sure to give your controls a classname of fl-control. If you're using specifically the button styles with custom HTML make sure your buttons also have a button class and your selected elements a selected class.

Then in the update function, make sure to update the styles with update(). To ensure right-to-left read direction support works correctly call the style update functions after the read direction of the template has been updated (i.e. layout.update() has been called).

controlsStyle.update();
buttonStyle.update();
dropdownStyle.update();
sliderStyle.update();

Using defaults from @flourish/layout

There is an optional feature that allows you to inherit text and background color from the layout module. Just pass in the layout state object as a third argument when initializing the styles.

import { createButtonStyle } from "@flourish/ui-styles";
var buttonStyle = createButtonStyle(state.button_style, ".fl-control-buttons", state.layout);