Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaredpalmer/the-platform

Web. Components. 😂
https://github.com/jaredpalmer/the-platform

hooks react react-hooks react-suspense suspense

Last synced: 25 days ago
JSON representation

Web. Components. 😂

Awesome Lists containing this project

README 

        
![Repo Banner](./.github/repo-banner.png)



# The Platform



[![Blazing Fast](https://badgen.now.sh/badge/speed/blazing%20%F0%9F%94%A5/green)](https://npm.im/the-platform) [![Discord](https://img.shields.io/discord/769256827007139912?label=%F0%9F%92%AC%20%20join%20us%20on%20discord&style=plastic)](https://discord.com/invite/RevdZTYMzr)

[![Discord](https://img.shields.io/discord/769256827007139912?label=%F0%9F%92%AC%20%20join%20us%20on%20discord&style=plastic)](https://discord.com/invite/RevdZTYMzr)



Web API's turned into React Hooks and Suspense-friendly React components. #useThePlatform



## Install



> Note: React 16.8+ is required for Hooks.



### With npm



```sh

npm i the-platform --save

```



### Or with yarn



```sh

yarn add the-platform

```



## Examples



- [Basics](https://codesandbox.io/s/8kw6mpp3k9)

- [Low Quality Image Placeholder](https://codesandbox.io/s/vo3zjoq90)

- [Using `` and Stripe Checkout](https://codesandbox.io/s/wy63pynp55)



## API



<!-- START doctoc generated TOC please keep comment here to allow auto update -->

<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->



- [Hooks](#hooks)

  - [`useDeviceMotion()`](#usedevicemotion)

  - [`useDeviceOrientation()`](#usedeviceorientation)

  - [`useGeoPosition()`](#usegeoposition)

  - [`useNetworkStatus()`](#usenetworkstatus)

  - [`useMedia()`](#usemedia)

  - [`useScript()`](#usescript)

  - [`useStylesheet()`](#usestylesheet)

  - [`useWindowScrollPosition()`](#usewindowscrollposition)

  - [`useWindowSize()`](#usewindowsize)

- [Components](#components)

  - [`<Img>`](#img)

  - [`<Script>`](#script)

  - [`<Video>`](#video)

  - [`<Audio>`](#audio)

  - [`<Preload>`](#preload)

  - [`<Stylesheet>`](#stylesheet)

- [Authors](#authors)

- [Inspiration](#inspiration)



<!-- END doctoc generated TOC please keep comment here to allow auto update -->



## Hooks



### `useDeviceMotion()`



Detect and retrieve current device Motion.



#### Returns



[`DeviceMotionEvent`](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent)



#### Example



```js

import { useDeviceMotion } from 'the-platform';



const Example = () => {

  const { acceleration, rotationRate, interval } = useDeviceMotion();



  // ...

};

```



### `useDeviceOrientation()`



Detect and retrieve current device orientation.



#### Returns



[`DeviceOrientationEvent`](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent)



#### Example



```js

import { useDeviceOrientation } from 'the-platform';



const Example = () => {

  const { alpha, beta, gamma, absolute } = useDeviceOrientation();



  // ...

};

```



### `useGeoPosition()`



Retrieve Geo position from the browser. This will throw a promise (must use with Suspense).



#### Arguments



[`PositionOptions`](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions)



#### Returns



[`Position`](https://developer.mozilla.org/en-US/docs/Web/API/Position)



#### Example



```js

import { useGeoPosition } from 'the-platform';



const Example = () => {

  const {

    coords: { latitude, longitude },

  } = useGeoPosition();



  // ...

};

```



### `useNetworkStatus()`



Retrieve network status from the browser.



#### Returns



Object containing:



- `isOnline: boolean`: `true` if the browser has network access. `false`

  otherwise.



- `offlineAt?: Date`: Date when network connection was lost.



#### Example



```js

import { useNetworkStatus } from 'the-platform';



const Example = () => {

  const { isOnline, offlineAt } = useNetworkStatus();



  // ...

};

```



### `useMedia()`



#### Arguments



`query: string | object`: media query string or object (parsed by [json2mq](https://github.com/akiran/json2mq)).

`defaultMatches: boolean`: a boolean providing a default value for matches



#### Returns



`match: boolean`: `true` if the media query matches, `false` otherwise.



#### Example



```js

import { useMedia } from 'the-platform';



const Example = () => {

  const small = useMedia('(min-width: 400px)');

  const medium = useMedia({ minWidth: 800 });



  // ...

};

```



### `useScript()`



This will throw a promise (must use with Suspense).



#### Arguments



Object containing:



- `src: string`: The script's URI.



```js

import { useScript } from 'the-platform';



const Example = () => {

  const _unused = useScript({ src: 'bundle.js' });



  // ...

};

```



### `useStylesheet()`



This will throw a promise (must use with Suspense).



#### Arguments



Object containing:



- `href: string`: The stylesheet's URI.

- `media?: string`: Intended destination media for style information.



```js

import { useStylesheet } from 'the-platform';



const Example = () => {

  const _unused = useStylesheet({ href: 'normalize.css' });



  // ...

};

```



### `useWindowScrollPosition()`



#### Returns



Object containing:



- `x: number`: Horizontal scroll in pixels (`window.pageXOffset`).

- `y: number`: Vertical scroll in pixels (`window.pageYOffset`).



#### Example



```js

import { useWindowScrollPosition } from 'the-platform';



const Example = () => {

  const { x, y } = useWindowScrollPosition();



  // ...

};

```



### `useWindowSize()`



#### Returns



Object containing:



- `width`: Width of browser viewport (`window.innerWidth`)

- `height`: Height of browser viewport (`window.innerHeight`)



#### Example



```js

import { useWindowSize } from 'the-platform';



const Example = () => {

  const { width, height } = useWindowSize();



  // ...

};

```



## Components



### `<Img>`



#### Props



- `src: string`

- anything else you can pass to an `<img>` tag



```js

import React from 'react';

import { Img } from 'the-platform';



function App() {

  return (

    <div>

      <h1>Hello</h1>

      <React.Suspense maxDuration={300} fallback={'loading...'}>

        <Img src="https://source.unsplash.com/random/4000x2000" />

      </React.Suspense>

    </div>

  );

}



export default App;

```



### `<Script>`



#### Props



- `src: string`

- `children?: () => React.ReactNode` - This render prop will only execute _after_ the script has loaded.

- anything else you can pass to a `<script>` tag



```js

import React from 'react';

import { Script } from 'the-platform';



function App() {

  return (

    <div>

      <h1>Load Stripe.js Async</h1>

      <React.Suspense maxDuration={300} fallback={'loading...'}>

        <Script src="https://js.stripe.com/v3/" async>

          {() => console.log(window.Stripe) || null}

        

      

    

  );

}



export default App;

```



### ``



#### Props



- `src: string`

- anything else you can pass to a `` tag



```js

import React from 'react';

import { Video } from 'the-platform';



function App() {

  return (

    


      
Ken Wheeler on a Scooter


      

        

      

    


  );

}



export default App;

```



### ``



#### Props



- `src: string`

- anything else you can pass to a `` tag



```js

import React from 'react';

import { Audio } from 'the-platform';



function App() {

  return (

    


      
Meavy Boy - Compassion


      {/* source: http://freemusicarchive.org/music/Meavy_Boy/EP_71_to_20/Compassion */}

      

        

      

    


  );

}



export default App;

```



### ``



Preload a resource with ``. For more information check out [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content) or the [Google Developer Blog](https://developers.google.com/web/updates/2016/03/link-rel-preload).



#### Props



- `href: string`

- `as: string` - resource type



```js

import React from 'react';

import { Preload, Script } from 'the-platform';



function App() {

  return (

    


      
Preload


      

        

        

      

    


  );

}



export default App;

```



### ``



Lazy load a stylesheet.



#### Props



- `href: string`



```js

import React from 'react';

import { Stylesheet } from 'the-platform';



function App() {

  return (

    


      
Styles


      

        

      

    


  );

}



export default App;

```



## Authors



- [Jared Palmer](https://twitter.com/jaredpalmer)

- [Jack Cross](https://twitter.com/crosscompile)

- [Nathan Force](https://twitter.com/forcetheissue)



## Inspiration



- [react-fns](https://github.com/jaredpalmer/react-fns)

- AOL.



---



MIT License