Last updated

Playlist

The Playlist component displays a collection of media items from a Fluid library.

Usage

<fluid-playlist library-id="your-library-id"></fluid-playlist>

Attributes

AttributeTypeDefaultDescription
library-idstringLibrary/playlist ID to display
hide-widgetbooleanfalseWhether to hide the component
class-namestringAdditional CSS classes

Display Options

AttributeTypeDefaultDescription
layoutstring'grid'Layout mode: 'grid', 'list', 'carousel'
columnsnumber3Number of columns in grid layout
show-titlesbooleantrueShow media titles
show-descriptionsbooleanfalseShow media descriptions

Examples

Grid Layout

<fluid-playlist
  library-id="your-library-id"
  layout="grid"
  columns="4"
></fluid-playlist>
<fluid-playlist
  library-id="your-library-id"
  layout="carousel"
></fluid-playlist>

List with Descriptions

<fluid-playlist
  library-id="your-library-id"
  layout="list"
  show-descriptions="true"
></fluid-playlist>

JavaScript API

// Get library/playlist data
const library = await window.FairShareSDK.getLibrary("library-slug-or-id");

console.log('Library name:', library.name);
console.log('Media items:', library.media.length);
  • getLibrary — Get library data programmatically
  • Media — Display individual media items