Skip to content

Commit

Permalink
chore: Update @silvermine/standardization to v2.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
yokuze committed Nov 15, 2023
1 parent a9277dd commit 4ebd38c
Show file tree
Hide file tree
Showing 10 changed files with 236 additions and 498 deletions.
1 change: 1 addition & 0 deletions .markdownlint-cli2.cjs
3 changes: 0 additions & 3 deletions .markdownlint.json

This file was deleted.

30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Silvermine Video.js AirPlay Plugin

<!-- markdownlint-disable line-length -->
[![Build Status](https://travis-ci.org/silvermine/videojs-airplay.svg?branch=master)](https://travis-ci.org/silvermine/videojs-airplay)
[![Coverage Status](https://coveralls.io/repos/github/silvermine/videojs-airplay/badge.svg?branch=master)](https://coveralls.io/github/silvermine/videojs-airplay?branch=master)
[![Dependency Status](https://david-dm.org/silvermine/videojs-airplay.svg)](https://david-dm.org/silvermine/videojs-airplay)
[![Dev Dependency Status](https://david-dm.org/silvermine/videojs-airplay/dev-status.svg)](https://david-dm.org/silvermine/videojs-airplay#info=devDependencies&view=table)

<!-- markdownlint-enable line-length -->

## What is it?

Expand Down Expand Up @@ -62,12 +63,12 @@ configure the plugin:
* **`plugins.airPlay.buttonPositionIndex`** - a zero-based number specifying the index
of the AirPlay button among the control bar's child components (if
`addButtonToControlBar` is set to `true`). By default the AirPlay Button is added as
the last child of the control bar. A value less than 0 puts the button at the specified
position from the end of the control bar. Note that it's likely not all child components
of the control bar are visible.
* **`plugins.airPlay.addAirPlayLabelToButton`** (default: `false`) - by default, the AirPlay
button component will display only an icon. Setting `addAirPlayLabelToButton` to `true`
will display a label titled `"AirPlay"` alongside the default icon.
the last child of the control bar. A value less than 0 puts the button at the
specified position from the end of the control bar. Note that it's likely not all
child components of the control bar are visible.
* **`plugins.airPlay.addAirPlayLabelToButton`** (default: `false`) - by default, the
AirPlay button component will display only an icon. Setting `addAirPlayLabelToButton`
to `true` will display a label titled `"AirPlay"` alongside the default icon.

For example:

Expand Down Expand Up @@ -100,13 +101,15 @@ player.airPlay(); // initializes the AirPlay plugin

The `AirPlayButton` component has two translated strings: "Start AirPlay" and "AirPlay".

* The "Start AirPlay" string appears in both of the standard places for Button component
text: inside the `.vjs-control-text` span and as the `<button>` element's `title` attribute.
* The "Start AirPlay" string appears in both of the standard places for Button
component text: inside the `.vjs-control-text` span and as the `<button>` element's
`title` attribute.
* The "AirPlay" string appears in an optional label within the Button component: inside
the `.vjs-airplay-button-label` span.

To localize the AirPlay button text, follow the steps in the [Video.js Languages tutorial][videojs-docs]
to add `"Start AirPlay"` and `"AirPlay"` keys to the map of translation strings.
To localize the AirPlay button text, follow the steps in the [Video.js Languages
tutorial][videojs-docs] to add `"Start AirPlay"` and `"AirPlay"` keys to the map of
translation strings.

### Using the npm module

Expand Down Expand Up @@ -141,8 +144,9 @@ image files:
* **`$icon-airplay--default`** - the path to the icon image that is displayed when the
AirPlay button is in its normal, default state. Defaults to
`"images/ic_airplay_white_24px.svg"`.
* **`$icon-airplay--hover`** - the path to the icon image that is displayed when the user
hovers over the AirPlay button. Defaults to `"images/ic_airplay_white_24px.svg"`.
* **`$icon-airplay--hover`** - the path to the icon image that is displayed when the
user hovers over the AirPlay button. Defaults to
`"images/ic_airplay_white_24px.svg"`.
* **`$airplay-icon-size`** - the width and height of the icon (the button and icon is a
square). Defaults to `12px`.

Expand Down
Loading

0 comments on commit 4ebd38c

Please sign in to comment.