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

@bbc/psammead-media-indicator

v6.1.18

Published

Provides a play icon and media duration for media page promos

Downloads

804

Readme

psammead-media-indicator - Known Vulnerabilities Dependency Status peerDependencies Status Storybook GitHub license npm version PRs Welcome

Description

The MediaIndicator component provides a 'play', 'audio' or 'camera' icon as well as an optional duration timestamp depending on the type prop. The component by default renders the 'play' icon. This component has options for both providing and not providing a duration. If one isn't provided, it will simply render the play, audio or camera icon.

Installation

npm install @bbc/psammead-media-indicator

Props

| Argument | Type | Required | Default | Example | | ---------- | ------- | -------- | ------- | ------------ | | type | string | no | 'video' | 'audio' | | script | object | yes | N/A | { canon: { groupA: { fontSize: '28', lineHeight: '32',}, groupB: { fontSize: '32', lineHeight: '36', }, groupD: { fontSize: '44', lineHeight: '48', }, }, trafalgar: { groupA: { fontSize: '20', lineHeight: '24', }, groupB: { fontSize: '24', lineHeight: '28', }, groupD: { fontSize: '32', lineHeight: '36', }, }, } | | service | string | yes | N/A | 'news' | | dir | string | no | 'ltr' | 'rtl' | | isInline | boolean | no | false | true | | children | node | no | null | |

Supported types

  • 'video'
  • 'audio'
  • 'photogallery'

Usage

The typical use-case of this component is on top of images within promos for articles that contains a video asset at the top of the page. It indicates to the user that the link is to a video and how long the video is in duration.

Top story promos can also have related stories links called Index Alsos. When an Index Also item is a video, audio or photogallery, an icon should be displayed with the content using the MediaIndicator component passing the isInline prop.

import MediaIndicator from '@bbc/psammead-media-indicator';
import { latin } from '@bbc/gel-foundations/scripts';

<MediaIndicator type="audio" script={latin} service="news" />;

When using this component ensure you add the relevant spacing.

E.g.

import styled from '@emotion/styled';
import MediaIndicator from '@bbc/psammead-media-indicator';
import { latin } from '@bbc/gel-foundations/scripts';

const TimeDuration = styled.time`
  margin: 0 ${GEL_SPACING_HLF};
`;

<MediaIndicator type="audio" script={latin} service="news">
  <TimeDuration datetime="PT2M15S">2:15</TimeDuration>
</MediaIndicator>;

When to use this component

The MediaIndicator component is designed to be used on top of an image which is linking to a page containing a video, audio or photo item based on that image. It tells the user to expect video, audio or photographic content on the page as well as how long it is in duration if applicable.

Also, it is used in Top story promos within Index Alsos media links.

Accessibility notes

This component is marked as aria-hidden="true", which means that it should be ignored by screenreaders. It is expected that media promos provide detailed information about their content such as duration in visually hidden text in the promo headline.

Contributing

Psammead is completely open source. We are grateful for any contributions, whether they be new components, bug fixes or general improvements. Please see our primary contributing guide which can be found at the root of the Psammead respository.

Code of Conduct

We welcome feedback and help on this work. By participating in this project, you agree to abide by the code of conduct. Please take a moment to read it.

License

Psammead is Apache 2.0 licensed.