Progressive-web-sdk NPM

 (                                                                              (    (         )
 )\ )                                                   (  (               )    )\ ) )\ )   ( /(
(()/( (         (  (  (      (         (    )      (    )\))(   '   (   ( /(   (()/((()/(   )\())
 /(_)))(    (   )\))( )(    ))\ (   (  )\  /((    ))\  ((_)()\ )   ))\  )\())   /(_))/(_))|((_)\
(_)) (()\   )\ ((_))\(()\  /((_))\  )\((_)(_))\  /((_) _(())\_)() /((_)((_)\   (_)) (_))_ |_ ((_)
| _ \ ((_) ((_) (()(_)((_)(_)) ((_)((_)(_)_)((_)(_))   \ \((_)/ /(_))  | |(_)  / __| |   \| |/ /
|  _/| '_|/ _ \/ _` || '_|/ -_)(_-<(_-<| |\ V / / -_)   \ \/\/ / / -_) | '_ \  \__ \ | |) | ' <
|_|  |_|  \___/\__, ||_|  \___|/__//__/|_| \_/  \___|    \_/\_/  \___| |_.__/  |___/ |___/ _|\_\
               |___/

A set of components and utilities which make up the SDK for Progressive Web

You can find the latest version of the SDK Docs on DevCenter

Requirements

Git
We recommend you use nvm to manage node and npm versions.
Node ^10.17.0 or ^12.x
npm ^5.7.1 or ^6.11.3

Install Dependencies

npm i

Usage

The Progressive Web SDK has a number of components that can be used in progressive web builds. Component documentation and examples can be seen by running our styleguide:

npm run docs:dev

You can now view the styleguide at http://localhost:9000.

Our docs are built on styleguidist.

Use the SDK in a project

To use the progressive-web-sdk in a project, add it as a dev-dependency to your package.json. Once you have done that, run npm install.

Components can now be imported into your project by loading the build files from dist:

import Button from 'progressive-web-sdk/dist/components/button'

const myButton = <Button text="Take My Money!" />

If you are actively developing a new library or component in the SDK, run the following command in order for the files to be built into dist when making changes in src:

npm run dev:watch

Marking public API functions as experimental or deprecated

To mark a function as experimental or deprecated in code, you can use the utility functions experimental() or deprecate() from progressive-web-sdk/src/utils/warnings within your experimental/deprecated function. This will prompt a warning in the browser whenever your function is used. You can add an additional custom message to the warning by passing a string into the first parameter.

Example usage:

import {experimental} from './utils/warnings'

someExperimentalFunction() => {
  // regular usage
  experimental()

  // the function implementation
}

This is the warning that will print in your browser: [MOBIFY API WARNING]: You are currently using an experimental function: [someExperimentalFunction] This function may change at any time.

import {deprecate} from './utils/warnings'

someFunctionToBeDeprecated() => {
  // with custom message
  deprecate("It will be removed in version 1.2.3. Please use [newFunction] instead.")

  // the function implementation
}

This is the warning that will print in your browser: [MOBIFY API WARNING]: You are currently using an deprecated function: [someFunctionToBeDeprecated]. It will be removed in version 1.2.3. Please use [newFunction] instead.

Documentation

Please see the Documentation README.

@infinitebrahmanuniverse/nolb-prog @everything-registry/sub-chunk-2478

1 year ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.11.1-cache-invalidation-2

4 years ago

1.14.0

4 years ago

1.14.0-alpha.1

4 years ago

1.14.0-alpha.0

4 years ago

1.11.1-cache-invalidation

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.9.0-release-candidate.1

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.8.0-release-candidate

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.7.0-release-candidate.3

5 years ago

1.7.0-release-candidate.2

5 years ago

1.7.0-release-candidate

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

1.6.0-release-candidate.1

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

1.5.0-release-candidate.1

6 years ago

1.5.0-release-candidate.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

1.4.0-release-candidate.6

6 years ago

1.4.0-release-candidate.5

6 years ago

1.4.0-release-candidate.3

6 years ago

1.4.0-release-candidate.2

6 years ago

1.4.0-release-candidate.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

1.3.0-release-candidate.0

6 years ago

1.2.1-preview.1

6 years ago

1.2.1-preview.0

6 years ago

1.2.0

6 years ago

1.2.0-release-candidate.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

1.1.0-release-candidate.1

6 years ago

1.1.0-release-candidate.0

6 years ago

1.1.0-preview.1

6 years ago

1.0.0

6 years ago

0.24.2

6 years ago

1.0.0-release-candidate.1

6 years ago

1.0.0-release-candidate.0

6 years ago

0.25.0-release-candidate.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.24.1-release-candidate

6 years ago

0.24.0-release-candidate

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.23.0-release-candidate.2

6 years ago

0.23.0-release-candidate.1

6 years ago

0.23.0-release-candidate.0

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.22.1-release-candidate.3

7 years ago

0.22.1-release-candidate.2

7 years ago

0.22.1-release-candidate.1

7 years ago

0.22.1-release-candidate.0

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.17.3-beta-publish.2

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago