stickerface-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.1.7 • Public • Published

stickerface-sdk

Made with create-react-library

NPM JavaScript Style Guide

Install

npm

npm install --save stickerface-sdk

yarn

yarn add stickerface-sdk

yarn add stickerface-sdk@<version>

Usage

StickerFaceEditor

import React, { useState } from 'react'

import { StickerFaceEditor, TransportContextProvider } from 'stickerface-sdk'
import 'stickerface-sdk/dist/index.css'

const App = () => {
  const [layers, setLayers] = useState<string | null>();

  return (
    <div className={'container'}>
      <TransportContextProvider>
        <StickerFaceEditor
          layers={layers}
          size={{
            width: '100%',
            height: '100%',
          }}
          onInit={() => {
            console.log('On init')
          }}
          showButtonSaveAvatar
          onSave={(layers) => {
            setLayers(layers)
          }}
        />
      </TransportContextProvider>
    </div>
  )
}

export default App

Screenshot 2022-11-07 at 21 10 59

Params StickerFaceEditor

showButtonSaveAvatar?: boolean

layers: string | null

size: { width: string, height: string }

onInit: () => void

onInit={() => {
  console.log('On init')
}}

Use onChange when showButtonSaveAvatar = false

onChange: (layers: string) => void

onChange={(layers) => {
  // @ts-ignore
  setLayers(layers?.data?.data)
}}

Use onSave when showButtonSaveAvatar = true

onSave?: (layers: string) => void

onSave={(layers) => {
  setLayers(layers)
}}

config: IConfig

interface IConfig {
  excludedSections?: string
  selectedSections?: string
}

StickerFaceAvatar

Screenshot 2022-11-02 at 16 15 01

Add 4 blocks to the top part inside the body

<body>
  <div id="render-canvas-container"></div>
  <div id="render-continer"></div>
  <script type="text/javascript" src="https://stickerface.io/api/init-min.js"></script>
  <script type="text/javascript" src="https://stickerface.io/js/render.js"></script>
...
import React from 'react'

import { StickerFaceAvatar } from 'stickerface-sdk'

const App = () => {
  const layers = '1;83;73;3412;100;6;219;214;203;7;11;28;68;13;320;2;273;159;160';
  
  return (
    <div className={'container'}>
      <StickerFaceAvatar layers={layers} noBackground={false} />
    </div>
  )
}

export default App

Params StickerFaceAvatar

interface IAvatarProps {
  layers: string
  noBackground?: boolean
}

License

MIT © Dimitreee | Thepetruha

Readme

Keywords

none

Package Sidebar

Install

npm i stickerface-sdk

Weekly Downloads

1

Version

1.1.7

License

MIT

Unpacked Size

79.6 kB

Total Files

18

Last publish

Collaborators

  • thepetruha