Catalog npm
PACKAGE EXPLORERView in registry

3dily

npm

3DILY

360 image viewer3d3d model viewer3dilyviewer
Versions collected14
Direct dependencies0From release 1.1.3-beta
Last observed20 Oct, 19:39 UTC

README

Current package documentation

What is 3dily?

3dily is a library for the use of 3dily.com customers, with which you can display 3D models and 360 images on your site.

Installing

In the examples below, the Threedily object comes either from:

UMD

  • Threedily will be registered as a global variable:
<link href="./dist/3dily.css" rel="stylesheet" type="text/css">
<script src="./dist/3dily.min.js"></script>

ESM Module

<link href="./dist/3dily.css" rel="stylesheet" type="text/css">
<script type="module">
  import { Threedily } from "./dist/3dily.esm.min.js";
</script>

NPM

import { Threedily } from '3dily'
import '3dily/style.css'

Usage

<div id="3dily-viewer"></div>
<script>
    const opts = {
        containerId: '3dily-viewer',
        panelId: '6314455ed74d211b23946bbd',
        productCode: 'kamran',
    }
    const threedily = Threedily(opts)
</script>

React

App.js

import { useEffect, useRef } from "react";
import { Threedily } from "3dily";
import "3dily/style.css";

const App = () => {
  const threedily = useRef();

  useEffect(() => {
    threedily.current = Threedily({
      panelId: "6314455ed74d211b23946bbd",
      productCode: "kamran",
      containerId: "3dily-viewer",
    });
    return () => threedily.current?.remove();
  }, []);

  return (
    <div id="3dily-viewer" style={{ width: "500px", height: "500px" }}></div>
  );
};

export default App;

Options

NameDescriptionDefault Value
containerId (required)The container element that we render threedily tool on this element_
panelId (required)The panel id that you can access thier product. Steps to get panelId: Log in to your panel > Profile > API key_
productCode (required)Code of the product_
modewhich feature of threedily do you want to use for your product ? 360 or modelauto
shadowshadow use for adding shadow on the printed productfalse
variantsYou specify the default variants_
backgroundthe background of product that want to show#FFFFFF
autoARautomaticly in mobile must go to ar workspacefalse
arUrlthe url address of ar that we want to openCurrent page

Methods

NameParameterDescription
changeVariants({ layer: variant })You can change the variants using this method. The input parameter must be an object of layer code and variant code, for example: { leg: 'blue', feet: 'brown', ... }
changeBackground(color)The color value can be a string of hex, hsl, rgb and color name (color is required)
toggleShadow(value)The parameter is optional, if no value is given, it will be false if it is true and vice versa
getData()With this method, you can get scene data
remove()You can delete the scene with this method
on(eventName, cb)With this method, you can add a callback to the desired event
off(eventName, cb)With this method, you can remove a callback from the desired event

Events

nameArgumentsDescription
change-frame(frame)Event will fired on active frame change

Demos

Simple

React

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 14

Collected releases
VersionPublishedDirect dependenciesOpen version
1.1.3-betaRegistry latest19 Sept 20220
1.1.214 Sept 20220
1.1.114 Aug 20220
1.1.024 Jul 20220
1.0.924 Jul 20220
1.0.85 Jul 20220
1.0.728 Jun 20220
1.0.628 Jun 20220
1.0.528 Jun 20220
1.0.427 Jun 20220
1.0.36 Jun 20220
1.0.26 Jun 20220
1.0.16 Jun 20220
1.0.02 Jun 20220

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
3dily/3dily

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:39 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:5c3713c38e8019a5120deefb3282af26ab3d847422eb42636ab2fe8a7a7a349c