room-gallery
TypeScript icon, indicating that this package has built-in type declarations

1.3.1-dev • Public • Published

RoomGallery - React / JavaScript / jQuery - 3D images slider

RoomGallery is a powerful and versatile 3D image gallery slider for your web application. It provides an immersive experience for displaying images or custom HTML content on virtual gallery walls. With RoomGallery, you can create stunning 3D presentations and galleries with a wide range of customization options.

Licensing Update

RoomGallery has moved to a paid model (after 2024/01/24 - v1.2.0) for the stable version. This means that all public beta versions can be used free of charge, provided they are used exclusively for development or testing purposes. For production versions, you need to purchase the full version of the software. You can do this by following the link: Purchase Full Version

Demo: https://formir.io/room-gallery/

Features

  • 3D Virtual Gallery: Create a virtual 3D gallery space with walls to display your images or HTML content.
  • Customizable: Customize the gallery's appearance and behavior using various configuration options.
  • Navigation: Navigate through the gallery using arrow buttons, keyboard shortcuts, or swipe gestures.
  • Dark Mode: Toggle dark mode for a different viewing experience.
  • Zoom Mode: Zoom in and out on images or content.
  • Pagination: Add pagination for easy item selection.
  • Events: Implement event callbacks to respond to gallery actions.

Installation

To use RoomGallery in your project, you can install it via npm:

npm install room-gallery

Usage in React

import React from "react";
import { createRoot } from "react-dom/client";
import RoomGallery from "room-gallery";

const dataFetch = async () => {
  const data = await (await fetch("./data.json")).json();
  return data.items;
};

const container = document.getElementById("root");
const root = createRoot(container);
root.render(<RoomGallery fetch={dataFetch} styles={{}} settings={{}} />);

ItemType

The ItemType is a TypeScript type that defines the structure of the primary data element in your data.json file, which is processed by your gallery. It provides a way to specify the properties and their types for individual items in your gallery.

Properties

  • title (optional): A string representing the title of the item.
  • description (optional): A string for a description of the item.
  • descriptionHtml (optional): A string containing HTML for the item's description.
  • image (optional): A string or an object representing the image associated with the item. It can include properties like prompt, original, and zoom.
  • html (optional): A string containing HTML content for the item.
  • video (optional): A string representing the URL of a video.
  • vimeo (optional): A string representing the URL of a Vimeo video.
  • youtube (optional): A string representing the URL of a YouTube video.
  • width (optional): A string with the item's width in the format of a number followed by a unit (e.g., "200px").
  • height (optional): A string with the item's height in the format of a number followed by a unit (e.g., "150px").

This type provides the structure for defining various properties for each item within your gallery's data. You can customize the properties based on the specific data you want to associate with each item.

Sample of json data

{
  "items": [
    {
      "image": "formir-room-thumb.png",
      "title": "The Room Gallery - React & jQuery plugin",
      "description": "Provided to you in Open Beta during testing and development process.",
      "height": "280px",
      "width": "280px"
    },
    {
      "image": "formir-500.png",
      "descriptionHtml": "<p style='margin: 0 0 10px'>Use for free: <a href='https://github.com/formir/room-gallery/'>Documentation</a></p><p style='margin: 0'></p><p style='font-size: 0.9rem; margin: 30px 0 10px'>Help with testing and improve:<br/><a href='https://github.com/formir/room-gallery/issues'>Report issue</a></p>",
      "height": "200px",
      "width": "200px"
    },
    {
      "image": {
        "prompt": "https://picsum.photos/id/239/600/400",
        "original": "https://picsum.photos/id/239/1200/800",
        "zoom": "https://picsum.photos/id/239/2400/1600"
      },
      "description": "Nullam placerat odio eget purus rhoncus, eget eleifend augue congue."
    },
    {
      "image": {
        "prompt": "https://picsum.photos/id/240/600/400",
        "original": "https://picsum.photos/id/240/1200/800",
        "zoom": "https://picsum.photos/id/240/2400/1600"
      },
      "description": "Nam vitae sem a arcu sodales rhoncus quis vel mi."
    }
  ]
}

Interface: RoomGalleryProps

fetch?: () => Promise<Array<ItemType>> | any | string

This optional property defines a function for fetching data, which is expected to return a promise that resolves to an array of ItemType, or it can return any other data type, such as a string. Use this function to load items dynamically. It can be used to populate the gallery with data. If not provided, the gallery may rely on the items property for static content.

items?: (ItemType[] | HTMLElement[])

An array of ItemType objects or HTMLElements representing the items in the room gallery. These items can be static content or can be preloaded for display within the gallery. If the fetch function is provided, it may override this static data.

styles?: object

An optional object that allows you to define custom styles for the room gallery. You can provide CSS styles using this property to customize the appearance of the gallery.

children?: JSX.Element[] | JSX.Element

This property allows you to pass JSX elements as children to the room gallery. It can be used to add additional content or components within the gallery.

settings?: RoomGallerySettingsType

An object that holds various settings for configuring the behavior and appearance of the room gallery. This can include options such as enabling/disabling features, adjusting layout, and more.

ref?: Ref<HTMLDivElement>

An optional reference to the HTML <div> element that represents the room gallery. This can be used to access and manipulate the gallery's DOM element directly. This reference can be passed to other parts of your application as needed.

you can also use children as node:

<RoomGallery styles={{}} settings={{}}>
	<div>
		<div className="item-image">
			<img src="url">
		</div>
		<div className="item-desc">
			<p>Title</p>
			<span>Description</span>
		</div>
	</div>
	<div>
		<div className="item-image">
			<img src="url">
		</div>
		<div className="item-desc">
			<p>Title</p>
			<span>Description</span>
		</div>
	</div>
</RoomGallery>

Usage Vanilla JavaScript

import RoomGallery from 'room-gallery/dist/RoomGallery'
import 'room-gallery/dist/RoomGallery.css'

const options = {
	element: document.getElementById('root'), // element in DOM to render gallery
	items: [{image: 'url', title: 'title', description: 'description'}], // optional items
	fetch: '//fetch-url' // optional fetch url or promise method
	styles: {},
	setting: {}

}
const room = new RoomGallery(options) // gallery will init by default
room.gotoNextItem() // use method to go to next

Methods on object

gotoNextItem(): void

This method allows you to navigate to the next item in the room gallery.

gotoPrevItem(): void

Use this method to navigate to the previous item in the room gallery.

toggleDarkMode(): void

This method toggles the dark mode in the room gallery.

setDarkMode(mode: boolean): void

You can use this method to set the dark mode in the room gallery by providing a boolean mode as a parameter.

toggleZoom(): void

This method toggles the zoom feature in the room gallery.

setZoom(zoom: boolean): void

To set the zoom feature in the room gallery, use this method with a boolean zoom as a parameter.

getCurrentItem(): {} | void

This method returns the current item in the room gallery.

refresh(): {} | void

This method rebuild stage and fetch new items if url was set.

clear(): {} | void

This method will clear the stage data and remove all walls.

Usage with jQuery

<head>
  <script
    src="https://code.jquery.com/jquery-3.7.1.min.js"
    integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo="
    crossorigin="anonymous"
  ></script>
  <script defer="defer" src="jQueryRoomGallery.js"></script>
  <script defer="defer" src="RoomGallery.js"></script>
  <link href="RoomGallery.css" rel="stylesheet" />
</head>
<body>
  <img src="url" title="Some title" alt="Some description" />
  <img src="url" title="Some title" alt="Some description" />
  <img src="url" title="Some title" alt="Some description" />
  <div id="room-gallery"></div>
</body>

Find images on page and give element

$('img').RoomGallery({element: $('#room-gallery').get(0), styles:{} settings:{}})

Find element and give images

$('#room-gallery').RoomGallery({items: $('img'), styles:{} settings:{}})
$('#room-gallery').data('RommGallery') // will give you access for control method and state

RoomGallery Settings

The settings type allows you to configure various aspects of your RoomGallery. It includes the following configuration options:

  • arrowNav: Defines how arrow navigation is displayed. Options are:

    • 'number': Display the item number (e.g., 1 of 10).
    • 'icon': Use arrow icons for navigation.
    • 'blank': Display nothing.
    • 'disabled': Disable arrow navigation.
  • darkNav: Specifies how dark mode navigation is displayed. Options are:

    • 'button': Use a button for toggling dark mode.
    • 'icon': Use an icon for toggling dark mode.
  • zoomNav: Specifies how zoom mode navigation is displayed. Options are:

    • 'button': Use a button for toggling zoom mode.
    • 'icon': Use an icon for toggling zoom mode.
  • darkMode: Defines the initial dark mode behavior. Options are:

    • 'dark': Start with dark mode enabled.
    • 'light': Start with dark mode disabled.
    • 'manual': Enable or disable dark mode manually.
    • 'auto': Automatically switch between dark and light modes based on user preferences.
  • zoomMode: Specifies the initial zoom mode behavior. Options are:

    • 'in': Start with zoom mode enabled.
    • 'out': Start with zoom mode disabled.
    • 'manual': Enable or disable zoom mode manually.
    • 'disabled': Disable zoom mode.
  • paginationsNav: Defines how pagination navigation is displayed. Options are:

    • 'button': Use button-style pagination.
    • 'text': Use text-based pagination.
  • paginations: Specifies how paginations are displayed. Options are:

    • 'number': Display item numbers.
    • 'title': Display title from item.title
    • 'thumb': Display thumb from item.image.thumb
    • 'blank': Display nothing.
    • 'disabled': Disable pagination.
  • paginationsOnZoom: Controls whether paginations are hidden when zoomed. Options are:

    • 'show': Paginations remain visible when zoomed.
    • 'hide': Hide paginations when zoomed.
  • arrowNavOnZoom: Specifies whether arrow navigation is hidden when zoomed. Options are:

    • 'show': Arrow navigation is visible when zoomed.
    • 'hide': Hide arrow navigation when zoomed.
  • defaultPosition: Sets the default position for the gallery.

  • allOnOneWall: If set to true, images will be placed only on the front wall. By default, this is set to false, and images will propagate across all four walls.

  • icons: Allows you to customize the icons used for navigation.

  • swipeToNav: Enables or disables swipe gestures for item navigation.

  • swipeToZoom: Enables or disables swipe gestures for zooming.

  • keypressToNav: Allows arrow key presses for item navigation.

  • keypressToZoom: Allows arrow key presses for zooming.

  • animationSpeed: Specifies the animation speed (in seconds)

    • 'min': Represents the time it takes to animate between switched walls. Default 2s.
    • 'ratio': Is the distance multiplier between the walls being switched. Default 1.
  • allOnOneWall: By setting this true, all items will apply only front wall (all 3 other wall will not be used). Default disabled.

  • sanitizeHtml: Enable or disable sanitization of all data that will be present in HTML mode, for example descriptions, or Item as HTML. Default enabled.

  • sanitizeHtmlOptions:

    • allowedTags: Array of string with tags that we will allow to display in case HTML.
    • allowedAttributes: Array of string with attribute that we will allow to display in case HTML.
  • event: Configures event callbacks for various gallery actions, such as initialization, rendering, showing next/previous items, toggling dark mode, zooming, and more.

Event Callbacks

The event property within the settings type allows you to define various event callbacks that get triggered during different actions in your RoomGallery. These event callbacks can be used to add custom behavior or handle specific actions. Here are the available event callbacks:

  • onInit(value?: object): This callback is invoked when the RoomGallery is initialized. You can perform any initialization tasks or setup actions here.
  • onRender(value?: object): Triggered when the RoomGallery is rendered. You can use this callback to perform actions after the gallery is rendered.
  • onShowNext(value?: object): Called when the user navigates to the next item. You can use this callback to add custom behavior when showing the next item.
  • onShowPrev(value?: object): Invoked when the user navigates to the previous item. Use this callback to add custom behavior when showing the previous item.
  • onZoomIn(value?: object): Triggered when the user zooms in. You can use this callback to perform actions when the gallery zooms in.
  • onZoomOut(value?: object): Called when the user zooms out. You can use this callback to perform actions when the gallery zooms out.
  • onDarkModeOn(value?: object): This callback is invoked when dark mode is turned on. You can use this callback to handle actions specific to enabling dark mode.
  • onDarkModeOff(value?: object): Called when dark mode is turned off. You can use this callback to handle actions specific to disabling dark mode.

StylesVariables Enum

The styles provides a set of predefined CSS variables used to style your RoomGallery. These variables can be customized to control the visual appearance of your gallery. Here are the available variables:

Core Room Styles:

  • rotateSpeed: Rotation speed in degrees per second.
  • rotateTiming: Timing function for rotation animation.
  • fontFamily: Font family for text content.
  • perspective: Perspective value for 3D transformation.
  • mobileSizeWidth: Width of the mobile viewport.
  • mobileSizeHeight: Height of the mobile viewport.
  • mobilePerspective: Perspective value for mobile view.
  • scale: Scaling factor for elements.
  • scaleZoom: Scaling factor for zoomed elements.
  • offsetY: Vertical offset for elements in percentage.
  • itemHeight: Height of items in the room.
  • itemWidth: Width of items in the room.
  • zIndex: Z-index for elements in the room.
  • textFontSize: Font size for text content.
  • textFontSizeMobile: Font size for text content on mobile devices.
  • fontLineHeight: Line height for text content.
  • textMarginTop: Margin top for text content.
  • textMaxHeight: Maximum height for text content.
  • textMinHeight: Minimum height for text content.
  • textMaxWidth: Maximum width for text content.
  • textPadding: Padding for text content.
  • navigationsMargin: Margin for navigational elements.
  • buttonSize: Size of buttons.
  • paginationButtonSize: Size of pagination buttons.
  • paginationButtonsSpace: Space between pagination buttons.
  • paginationButtonsBorderRadius Specifies the border radius of pagination buttons.
  • paginationThumbsMaxHeight: Specify max height of thumbs images in paginations.
  • paginationThumbMaxWidth: Max width of thumb in pagination.
  • navButtonSize: Size of navigation buttons.
  • buttonsPosition: Position of buttons.
  • buttonZoomPosition: Position of zoom button.
  • buttonDarkPosition: Position of dark button.
  • buttonZoomWidth: Width of zoom button.
  • buttonExitWidth: Width of exit button.
  • buttonDarkWidth: Width of dark button.
  • paginationPosition: Position of pagination elements.
  • buttonTransition: Transition effect for buttons.
  • buttonOpacity: Opacity value for buttons.

Light Room Styles:

  • lightBackgroundBlendMode
  • lightBodyBackground
  • lightTextColor
  • lightLinkColor
  • lightFloorBackground
  • lightFloorShadow
  • lightWallBackground
  • lightWallShadow
  • lightCeilBackground
  • lightCeilShadow
  • lightButtonBackground
  • lightButtonColor
  • lightButtonBorder
  • lightButtonShadow
  • lightButtonCurrentBackground
  • lightButtonCurrentBorder
  • lightButtonCurrentColor
  • lightButtonCurrentShadow
  • lightCanvasBorder
  • lightCanvasShadow

Dark Room Styles:

  • darkBackgroundBlendMode
  • darkBodyBackground
  • darkTextColor
  • darkLinkColor
  • darkFloorBackground
  • darkFloorShadow
  • darkWallBackground
  • darkWallShadow
  • darkCeilBackground
  • darkCeilShadow
  • darkButtonBackground
  • darkButtonColor
  • darkButtonBorder
  • darkButtonShadow
  • darkButtonCurrentBackground
  • darkButtonCurrentBorder
  • darkButtonCurrentColor
  • darkButtonCurrentShadow
  • darkCanvasBorder
  • darkCanvasShadow

These CSS variables allow you to control the styling of various components and elements within your RoomGallery. You can override these variables to create a custom look and feel for your gallery.

Core Setup in Sass (src/sass/room-gallery.scss)

  • $room-size-width: Default width of room gallery - 100vmax
  • $room-size-height: Default height of gallery - 100vmin
  • $room-mobile-media-width: Mobile breakpoint - 945px (Do not use % unit or calc(). You can use px, rem, cm, vh, vw, etc.)
  • $room-mobile-size-width: Mobile width of gallery after mobile breakpoint - 100vw (Do not use % unit or calc(). Recommended 100vw)
  • $room-mobile-size-height: Mobile height of gallery after mobile breakpoint - 100vh (Recommended 100vh)

Sass variables for classes names setup:

  • $room: main wrapper
  • $room-dark: dark room wrapper
  • $room-dark-auto: automatic dark room wrapper
  • $room-body: body of the room
  • $room-arena: wrapper for the arena
  • $room-walls: walls in 3D
  • $room-wall: individual wall
  • $room-wall-active: active wall
  • $room-ceil: ceiling
  • $room-floor: floor
  • $room-item: item to display on the wall
  • $room-item-active: active item
  • $room-item-image: image container
  • $room-item-desc: image description
  • $room-zoom: zoom control input
  • $room-paginations: pagination wrapper
  • $room-paginations-thumbs: pagination wrapper for thumbs
  • $room-navigations: navigation wrapper
  • $room-prev-button: previous button
  • $room-next-button: next button
  • $room-icon: icon
  • $room-zoom-button: zoom in button- $room-dark-button: dark mode button
  • $room-exit-button: exit zoom button
  • $room-canvas: border/canvas style

Sass variables editable in JS:

  • $room-rotate-speed: Specifies the rotation speed of the room. The default value is 2s.
  • $room-rotate-timing: Specifies the timing function for the room rotation animation. The default value is ease-in-out.
  • $room-font-family: Specifies the font family for the room. The default value is Arial.
  • $room-perspective: Specifies the perspective value for the room. It is a Sass variable that is set to the value of $room-size-width.
  • $room-mobile-perspective: Specifies the perspective value for the room on mobile devices. It is a Sass variable that is set to the value of $room-mobile-size-width.
  • $room-scale: Specifies the scale factor for the room. The default value is 1.1.
  • $room-scale-zoom: Specifies the zoom scale factor for the room. The default value is 1.5.
  • $room-offset-y: Specifies the vertical offset of the room. The default value is 0 and it is expressed as a percentage.
  • $room-item-height: Specifies the height of the room items. The default value is 90%.
  • $room-item-width: Specifies the width of the room items. The default value is 90%.
  • $room-zindex: Specifies the z-index value for the room. The default value is 1000.
  • $room-icon-blend-mode: Specifies the mix blend mode for navs icons. The default value is difference.
  • $room-text-font-size: Specifies the font size for the room text. The default value is 14px.
  • $room-text-font-size-mobile: Specifies the font size for the room text on mobile devices. The default value is 2vmin.
  • $room-font-line-height: Specifies the line height for the room text. The default value is 1.3em.
  • $room-text-margin-top: Specifies the top margin for the room text. The default value is 1.5rem.
  • $room-text-max-height: Specifies the maximum height for the room text. The default value is 20%.
  • $room-text-min-height: Specifies the minimum height for the room text. The default value is 15%.
  • $room-text-max-width: Specifies the maximum width for the room text. The default value is 70%.
  • $room-text-padding: Specifies the padding for the room text. The default value is 20px 0.
  • $room-navigations-margin: Specifies the margin for the room navigations. The default value is 20px.
  • $room-button-size: Specifies the size of the room buttons. The default value is 35px.
  • $room-pagination-button-size: Specifies the size of the room pagination buttons. The default value is 25px.
  • $room-pagination-buttons-space: Specifies the space between room pagination buttons. The default value is 7px.
  • $room-pagination-buttons-border-radius: Specifies the border radius of pagination buttons (also thumbs). The default value is $room-button-size.
  • $room-pagination-thumbs-max-height: Specify max height of thumbs images in paginations. The default value is 15%.
  • $room-pagination-thumb-max-width: Max width of thumb in pagination. The default value is 100px.
  • $room-nav-button-size: Specifies the size of the room navigation buttons. The default value is 35px.
  • $room-buttons-position: Specifies the position of the room buttons. The default value is 5%.
  • $room-button-zoom-position: Specifies the position of the zoom button in the room. The default value is 10%.
  • $room-button-dark-position: Specifies the position of the dark mode button in the room. The default value is 10%.
  • $room-button-zoom-width: Specifies the width of the zoom button in the room. The default value is 35px.
  • $room-button-exit-width: Specifies the width of the exit button in the room. The default value is 35px.
  • $room-button-dark-width: Specifies the width of the dark mode button in the room. The default value is 35px.
  • $room-pagination-position: Specifies the position of the room pagination. The default value is 5%.
  • $room-button-transition: Specifies the transition property for the room buttons. The default value is opacity 0.5s linear.
  • $room-button-opacity: Specifies the opacity value for the room buttons. The default value is 1.
  • $room-background-blend-mode: Specifies the blend mode for the room background.
  • $room-body-background: Specifies the background color for the room body.
  • $room-text-color: Specifies the color for the room text.
  • $room-link-color: Specifies the color for the room links.
  • $room-floor-background: Specifies the background image and repeat pattern for the room floor.
  • $room-floor-shadow: Specifies the shadow effect for the room floor.
  • $room-wall-background: Specifies the background image and repeat pattern for the room walls.
  • $room-wall-shadow: Specifies the shadow effect for the room walls.
  • $room-ceil-background: Specifies the background image and repeat pattern for the room ceiling.
  • $room-ceil-shadow: Specifies the shadow effect for the room ceiling.
  • $room-button-background: Specifies the background color for the room buttons.
  • $room-button-color: Specifies the color for the room buttons.
  • $room-button-border: Specifies the border style for the room buttons.
  • $room-button-shadow: Specifies the shadow effect for the room buttons.
  • $room-button-current-background: Specifies the background color for the current room button.
  • $room-button-current-border: Specifies the border style for the current room button.
  • $room-button-current-color: Specifies the color for the current room button.
  • $room-button-current-shadow: Specifies the shadow effect for the current room button.
  • $room-button-current-shadow: Specifies the shadow effect for the current room button.
  • $room-icon-color: Specifies the nav icon color.
  • $room-canvas-border: Specifies the border style for the room canvas.
  • $room-canvas-shadow: Specifies the shadow effect for the room canvas.

Light sass variables:

  • $room-light-background-blend-mode: Specifies the blend mode for the light theme background. The default value is multiply.
  • $room-light-body-background: Specifies the background color for the light theme body. The default value is #fff.
  • $room-light-text-color: Specifies the color for the light theme text. The default value is #2d2d2d.
  • $room-light-link-color: Specifies the color for the light theme links. The default value is #2d2d2d.
  • $room-light-floor-background: Specifies the background image and repeat pattern for the light theme floor.
  • $room-light-floor-shadow: Specifies the shadow effect for the light theme floor.
  • $room-light-wall-background: Specifies the background image and repeat pattern for the light theme walls.
  • $room-light-wall-shadow: Specifies the shadow effect for the light theme walls.
  • $room-light-ceil-background: Specifies the background image and repeat pattern for the light theme ceiling.
  • $room-light-ceil-shadow: Specifies the shadow effect for the light theme ceiling.
  • $room-light-button-background: Specifies the background color for the light theme buttons. The default value is #3c3642.
  • $room-light-button-color: Specifies the color for the light theme buttons. The default value is #fff.
  • $room-light-button-border: Specifies the border style for the light theme buttons. The default value is 0 none.
  • $room-light-button-shadow: Specifies the shadow effect for the light theme buttons. The default value is 0 0 2px rgba(0, 0, 0, 0.5).
  • $room-light-button-current-background: Specifies the background color for the current light theme button. The default value is #fff.
  • $room-light-button-current-border: Specifies the border style for the current light theme button. The default value is 0 none.
  • $room-light-button-current-color: Specifies the color for the current light theme button. The default value is #3c3642.
  • $room-light-button-current-shadow: Specifies the shadow effect for the current light theme button. The default value is none.
  • $room-light-canvas-border: Specifies the border style for the light theme canvas. The default value is 10px solid #3c3642.
  • $room-light-canvas-shadow: Specifies the shadow effect for the light theme canvas. The default value is 1px 1px 3px rgba(0, 0, 0, 0.5).

Dark sass variables:

  • $room-dark-background-blend-mode: Specifies the blend mode for the dark theme background. The default value is screen.
  • $room-dark-body-background: Specifies the background color for the dark theme body. The default value is #1c1e24.
  • $room-dark-text-color: Specifies the color for the dark theme text. The default value is #fff.
  • $room-dark-link-color: Specifies the color for the dark theme links. The default value is #fff.
  • $room-dark-floor-background: Specifies the background image and repeat pattern for the dark theme floor.
  • $room-dark-floor-shadow: Specifies the shadow effect for the dark theme floor.
  • $room-dark-wall-background: Specifies the background image and repeat pattern for the dark theme walls.
  • $room-dark-wall-shadow: Specifies the shadow effect for the dark theme walls.
  • $room-dark-ceil-background: Specifies the background image and repeat pattern for the dark theme ceiling.
  • $room-dark-ceil-shadow: Specifies the shadow effect for the dark theme ceiling.
  • $room-dark-button-background: Specifies the background color for the dark theme buttons. The default value is #fff.
  • $room-dark-button-color: Specifies the color for the dark theme buttons. The default value is #000.
  • $room-dark-button-border: Specifies the border style for the dark theme buttons. The default value is 0 none.
  • $room-dark-button-shadow: Specifies the shadow effect for the dark theme buttons. The default value is 0 0 2px rgba(0, 0, 0, 0.5).
  • $room-dark-button-current-background: Specifies the background color for the current dark theme button. The default value is #000.
  • $room-dark-button-current-border: Specifies the border style for the current dark theme button. The default value is 0 none.
  • $room-dark-button-current-color: Specifies the color for the current dark theme button. The default value is #fff.
  • $room-dark-button-current-shadow: Specifies the shadow effect for the current dark theme button. The default value is 0 0 5px 5px rgba(255, 255, 255, 0.3).
  • $room-dark-canvas-border: Specifies the border style for the dark theme canvas. The default value is 10px solid $room-button-background.
  • $room-dark-canvas-shadow: Specifies the shadow effect for the dark theme canvas. The default value is 0 0 10px rgba(255, 255, 255, 0.1).

After all, the application will utilize CSS variables based on the dark or light mode dependency for the final result.

  • --room-body-background-blend-mode: $room-<light/dark>-background-blend-mode
  • --room-body-background: $room-<light/dark>-body-background
  • --room-text-color: $room-<light/dark>-text-color
  • --room-link-color: $room-<light/dark>-link-color
  • --room-floor-background: $room-<light/dark>-floor-background
  • --room-floor-shadow: $room-<light/dark>-floor-shadow
  • --room-wall-background: $room-<light/dark>-wall-background
  • --room-wall-shadow: $room-<light/dark>-wall-shadow
  • --room-ceil-background: $room-<light/dark>-ceil-background
  • --room-ceil-shadow: $room-<light/dark>-ceil-shadow
  • --room-button-background: $room-<light/dark>-button-background
  • --room-button-color: $room-<light/dark>-button-color
  • --room-icon-color: $room-<light/dark>-icon-color
  • --room-button-border: $room-<light/dark>-button-border
  • --room-button-shadow: $room-<light/dark>-button-shadow
  • --room-button-current-background: $room-<light/dark>-button-current-background
  • --room-button-current-border: $room-<light/dark>-button-current-border
  • --room-button-current-color: $room-<light/dark>-button-current-color
  • --room-button-current-shadow: $room-<light/dark>-button-current-shadow
  • --room-canvas-border: $room-<light/dark>-canvas-border
  • --room-canvas-shadow: $room-<light/dark>-canvas-shadow

Package Sidebar

Install

npm i room-gallery

Weekly Downloads

12

Version

1.3.1-dev

License

MIT

Unpacked Size

1.77 MB

Total Files

50

Last publish

Collaborators

  • konrad-k