Socket
Socket
Sign inDemoInstall

@justeat/f-skeleton-loader

Package Overview
Dependencies
13
Maintainers
29
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@justeat/f-skeleton-loader

Fozzie Skeleton Loader - Provides a visual indication that another component is loading.


Version published
Maintainers
29
Weekly downloads
1
decreased by-98%

Weekly downloads

Readme

Source

f-skeleton-loader

Fozzie Bear

Provides a visual indication that another component is loading. A set of predefined skeletonTypes render lightweight markup to represent the component that is loading.


npm version CircleCI Coverage Status Known Vulnerabilities


Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-skeleton-loader
npm install @justeat/f-skeleton-loader

Vue Applications

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

import SkeletonLoader from '@justeat/f-skeleton-loader';
import '@justeat/f-skeleton-loader/dist/f-skeleton-loader.css';

export default {
    components: {
        SkeletonLoader
    }
}

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

import '@justeat/f-skeleton-loader/dist/f-skeleton-loader.css';

export default {
    components: {
        // …
        SkeletonLoader: () => import(/* webpackChunkName: "skeleton-loader" */ '@justeat/f-skeleton-loader')
    }
}

Configuration

Props

There may be props that allow you to customise its functionality.

The props that can be defined are as follows (if any):

PropTypeDefaultDescription
skeletonTypeString""The predefined component skeleton to render

Development

Start by cloning the repository and installing the required dependencies:

$ git clone git@github.com:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-skeleton-loader package:

$ cd packages/components/molecules/f-skeleton-loader

Testing

Unit, Integration and Contract

To test all components, run from root directory. To test only f-skeleton-loader, run from the ./fozzie-components/packages/components/molecules/f-skeleton-loader directory.

yarn test

Component Tests

# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

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

OR

# Run Component tests for f-skeleton-loader
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/components/molecules/f-skeleton-loader
yarn test-component:chrome

##Acknowledgments

This component is heavily based on the Vuetify SkeletonLoader component https://github.com/vuetifyjs/vuetify/tree/master/packages/vuetify/src/components/VSkeletonLoader Huge thanks to the team and everyone involved in its development.

Documentation to be completed once module is in stable state.

Keywords

FAQs

Last updated on 14 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc