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

@justeat/f-segmented-control

v0.3.0

Published

Fozzie Segmented Control - A Segmented Control component is a group of toggle buttons that behave like a single choice element. It is useful for displaying a set of options to the user when only one option can be selected.

Downloads

5

Readme

f-segmented-control


npm version


Usage

A Segmented Control component is a group of toggle buttons that behave like a single choice element. It is useful for displaying a set of options to the user when only one option can be selected.

Import the SegmentedControl component in your .vue file and use it as follows:

<template>
    <SegmentedControl
        :screenreaderLabel="screenreaderLabel"
        :options="options"
        :size="size"
    />
</template>

<script>
import SegmentedControl from '@justeat/f-segmented-control';

export default {
    components: { SegmentedControl },
    data() {
        return {
            screenreaderLabel: 'Select an option',
            options: [
                { label: 'Option 1', iconName: 'SomeIconName' },
                { label: 'Option 2' },
                { label: 'Option 3', selected: true },
                { label: 'Option 4', disabled: true }
            ],
            size: 'large', // Can be 'small' or 'large', defaults to 'small'
        };
    }
};
</script>

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-segmented-control
npm install @justeat/f-segmented-control

Vue Applications

You can import it in your Vue SFC like this (please note that styles have to be imported separately):

import SegmentedControl from '@justeat/f-segmented-control';
import '@justeat/f-segmented-control/dist/f-segmented-control.css';

export default {
    components: {
        SegmentedControl
    }
}

If you are using Webpack, you can import the component dynamically to separate the segmented-control bundle from the main bundle.client.js:

import '@justeat/f-segmented-control/dist/f-segmented-control.css';

export default {
    components: {
        // …
        SegmentedControl: () => import(/* webpackChunkName: "segmented-control" */ '@justeat/f-segmented-control')
    }
}

Configuration

Props

| Prop | Type | Required | Default | Validator | Description | | --- | --- | --- | --- | --- | --- | | screenreaderLabel | String | true | N/A | N/A | The label that is read by screen readers to describe the segmented control | | options | Array | true | N/A | Array must have 2-4 elements, and each element must have a label property of type string. The iconName, disabled, and selected properties are optional. iconName corresponds with the name of a PIE Icon found here. selected will set the default selected option. You can only set this to true for one option. | An array of objects representing each button in the segmented control | | size | String | false | 'small' | Must be either 'small' or 'large'. | The size of the segmented control |

Events

The events that can be subscribed to are as follows:

| Event | Description | | ----- | ----------- | | input | Emitted when the user selects an option. The value emitted is the label of the selected option. |

Accessibility

The Segmented Control component follows accessibility best practices and includes support for keyboard navigation. Users can use the arrow keys to navigate between options and the space or enter key to select an option. The component also includes ARIA attributes for screen readers.

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [email protected]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-segmented-control package:

$ cd packages/components/atoms/f-segmented-control

Testing

To test all components, run from root directory. To test only f-segmented-control, run from the ./fozzie-components/packages/components/atoms/f-segmented-control directory.

Unit and Integration tests

yarn test

Component Tests

# Note: Ensure Storybook is running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome

Accessibility tests

yarn test-a11y:chrome

Documentation to be completed once module is in stable state.