https://github.com/zheeeng/omnistate

https://github.com/zheeeng/omnistate

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zheeeng/omnistate
• Owner: zheeeng
• License: mit
• Created: 2023-05-06T06:33:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-06T06:35:59.000Z (almost 3 years ago)
• Last Synced: 2025-08-27T05:27:13.753Z (8 months ago)
• Language: HTML
• Size: 142 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# React Device Frameset

[![NPM](https://nodei.co/npm/react-device-frameset.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/react-device-frameset/)

![publish workflow](https://github.com/zheeeng/react-device-frameset/actions/workflows/publish.yml/badge.svg)

![pages workflow](https://github.com/zheeeng/react-device-frameset/actions/workflows/pages.yml/badge.svg)

[![npm version](https://img.shields.io/npm/v/react-device-frameset.svg)](https://www.npmjs.com/package/react-device-frameset)

This is yet another device frameset component for React.

## [Demo](https://react-device-frameset.zheeeng.me)

## Features

* Powered by pure css device prototype showcase [Marvel Devices.css](http://marvelapp.github.io/devices.css/)

* [![language](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](http://typescriptlang.org/) Type Safe and under maintainable

* Sample for reference

  * Device Selector

![frameset-screenshot](https://user-images.githubusercontent.com/1303154/120062053-a58a6200-c092-11eb-9fec-fa0dd3609645.png)

  * Device Emulator

![frameset-screenshot](https://user-images.githubusercontent.com/1303154/132490604-f6d05da8-835d-437f-9b10-5ffec76e661f.png)

## Installation

```bash

yarn add react-device-frameset (or npm/pnpm)

```

## Usage

```tsx

import { DeviceFrameset } from 'react-device-frameset'

import 'react-device-frameset/lib/css/marvel-devices.min.css'

export const App = () => {

    return (

        

            
Hello world

        

    )

}

```


### Prop Signature

DeviceFramesetProps:

```ts (signature)

| { device: 'iPhone X', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPhone 8', color: 'black' | 'silver' | 'gold', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPhone 8 Plus', color: 'black' | 'silver' | 'gold', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPhone 5s', color: 'black' | 'silver' | 'gold', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPhone 5c', color: 'white' | 'red' | 'yellow' | 'green' | 'blue', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPhone 4s', color: 'black' | 'silver', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'Galaxy Note 8', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'Nexus 5', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'Lumia 920', color: 'black' | 'white' | 'yellow' | 'red' | 'blue', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'Samsung Galaxy S5', color: 'white' | 'black', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'HTC One', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'iPad Mini', color: 'black' | 'silver', landscape?: boolean, width?: number, height?: number, zoom?: number }

| { device: 'MacBook Pro', width?: number, height?: number, zoom?: number }

```

## If you like the frameset selector?

```ts (signature)

type DeviceName = "iPhone X" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 5s" | "iPhone 5c" | "iPhone 4s" | "Galaxy Note 8" | "Nexus 5" | "Lumia 920" | "Samsung Galaxy S5" | "HTC One" | "iPad Mini" | "MacBook Pro"

type DeviceEmulatorProps = {

    banDevices?: DeviceName[]

    children: (props: DeviceFramesetProps) => React.ReactNode,

    value?: DeviceName,

    onChange?: (deviceName: DeviceName) => void,

}

```

```tsx

import { DeviceFrameset, DeviceSelector } from 'react-device-frameset'

import 'react-device-frameset/lib/css/marvel-devices.min.css'

import 'react-device-frameset/lib/css/device-selector.min.css'

export const App = () => {

    return (

        

            {props => }

        

    )

}

```

## If you like the frameset emulator?

```ts (signature)

type DeviceName = "iPhone X" | "iPhone 8" | "iPhone 8 Plus" | "iPhone 5s" | "iPhone 5c" | "iPhone 4s" | "Galaxy Note 8" | "Nexus 5" | "Lumia 920" | "Samsung Galaxy S5" | "HTC One" | "iPad Mini" | "MacBook Pro"

type DeviceEmulatorProps = {

    banDevices?: DeviceName[]

    children: (props: DeviceFramesetProps) => React.ReactNode,

    value?: DeviceFramesetProps,

    onChange?: (deviceConfig: DeviceFramesetProps) => void,

}

```

```tsx

import { DeviceFrameset, DeviceEmulator } from 'react-device-frameset'

import 'react-device-frameset/lib/css/marvel-devices.min.css'

import 'react-device-frameset/lib/css/device-emulator.min.css'

export const App = () => {

    return (

        

            {props => }

        

    )

}

```