@windmillcode/angular-wml-slicebox NPM

Overview

The wml-slicebox library is an Angular-based library designed to enhance the visual interactivity of web applications by introducing a 3D slicebox carousel component. This library provides a sophisticated and engaging way to display images or content in a carousel format, with a 3D rotation effect that adds depth and dynamism to the user experience. Aimed at integrating seamlessly with Angular applications, wml-slicebox offers a set of configurable options to tailor the carousel's behavior and appearance, making it a versatile tool for developers looking to enhance their UI with 3D interactive elements.

At the heart of the wml-slicebox library is the WmlSliceboxComponent, which serves as the central component orchestrating the 3D slicebox carousel's functionality. This component manages the carousel's state, handles user interactions, and renders the 3D slices that comprise the carousel's visual structure. Developers can customize the carousel through a variety of parameters, such as orientation, rotation speed, and disperse factor, allowing for a high degree of control over the carousel's behavior and appearance. Additionally, the library provides mechanisms for dynamically loading content into the carousel and responding to user interactions, making it a flexible solution for presenting content in an engaging and interactive format. The component's design encourages modularity and reusability, adhering to Angular's component-based architecture, and offering developers a straightforward way to incorporate 3D carousel functionality into their applications.

Usage

npm install -s @windmillcode/wml-slicebox

import wml-slicebox into the needed module

// angular
import { NgModule } from '@angular/core';


import { WmlSliceboxModule } from '@windmillcode/wml-slicebox';


@NgModule({
  declarations: [
    ...
  ],
  imports: [
    WmlSliceboxModule
  ],
})
export class TargetModule { }

the use it in your component thats it

import { WmlSliceboxImg, WmlSliceboxParams } from '@windmillcode/wml-slicebox';

  sliceBoxParams = new WmlSliceboxParams({
    images: WmlSliceboxImg[],
  });

    <wml-slicebox [params]="sliceBoxParams" ></wml-slicebox>

Full Sample

import { WmlSliceboxImg, WmlSliceboxParams } from '@windmillcode/wml-slicebox';
import { faker } from '@faker-js/faker';
  pickers=[]
  images: WmlSliceboxImg[] = Array(5)
  .fill(null)
  .map((nullVal, index0) => {

    let img = new WmlSliceboxImg({
      src:faker.image.abstract(),//REPLACE with your image here
      value: index0.toString(),
    });

    this.pickers.push({
      value:index0,
      class:"unpicked"
    })

    return img;
  });

  sliceBoxParams = new WmlSliceboxParams({
    images: this.images,
    orientation:"v",
    // nextRotationDegree:"360deg",
    disperseFactor:40,
    disperseSpeed:4000,
    speed:1500,
    sequentialFactor:150,
    autoplay:false,
  });

  moveToNextSlide =()=>{
    this.sliceBoxParams.moveToNextSlideSubj.next()
  }

  moveToPrevSlide =()=>{
    this.sliceBoxParams.moveToPrevSlideSubj.next()
  }

  jumpToSlide = (myPicker:HomeMainPicker)=>{
    this.pickers
    .forEach((picker)=>{
      picker.class ="unpicked"
    })
    myPicker.class = "picked"

    this.sliceBoxParams.jumpToSlideSubj.next(myPicker.value)
    this.cdref.detectChanges()
  }

<div >
  <section >
    <div class=icon (click)="moveToPrevSlide()">
      <i class="fa-solid fa-chevron-left"></i>
    </div>
    <wml-slicebox [params]="sliceBoxParams" class=useThisClassToResizeSlicebox></wml-slicebox>
    <div class=icon (click)="moveToNextSlide()">
      <i class="fa-solid fa-chevron-right"></i>
    </div>
  </section>
  <section >
    <div (click)="jumpToSlide(picker)" [class]="picker.class" *ngFor="let picker of pickers">
      <label>{{picker.value}}</label>
    </div>
  </section>
</div>

Configs

Name	Type	Description	Default Value
autoplay	boolean	Whether the carousel should continue or not	`true`
colorHiddenSides	hex value, rgba, hsla	Color of the sides of the cuboid where the image is not shown	'#222'
cuboidsCount	number	The number of cuboids to be used in the slicebox	9
disperseFactor	number	How far away in pixels should the cuboids coordinate to move away from the center	40
disperseSpeed	number	Time in ms of how fast the cuboids coordinate to move away from the center	4000
easing	css animation easing types	The animation type	'ease-out'
images	WmlSliceboxImg[]	An array of images to provide to the slicebox	[]
interval	number	Milliseconds before the carousel navigates if autoplay is true	3000
jumpToSlideSubj	subject	Not to be edited; used to indicate to the slicebox to jump to a specific slide when autoplay is false	-
moveToNextSlideSubj	subject	Not to be edited; used to indicate to the slicebox to move to the next slide when autoplay is false	-
moveToPrevSlideSubj	subject	Not to be edited; used to indicate to the slicebox to move to the previous slide when autoplay is false	-
nextRotationDegree	css degree string	When provided, overrides the default rotation to have the next slides rotate according to your desires	`'-90deg'` if `reverse` is `true`, else `'90deg'`
orientation	'v' \| 'h'	Whether to rotate vertically or horizontally	'v'
perspective	px value	Same as perspective definition in graphic design	10000
prevRotationDegree	css degree string	When provided, overrides the default rotation to have the next slides rotate according to your desires	Opposite of `nextRotationDegree`
resizeDelay	number	Amount of time to debounce before the carousel resizes itself	10
reverse	boolean	Whether to reverse the default rotation	`false`
sequentialFactor	number	Time in ms before each cuboid consecutively rotates	350
sliceboxSizeUseProvidedValues	boolean	Whether to resize to fill the parent element or use specified height and width of the slicebox	`false`
speed	number	How fast each cuboid is supposed to rotate	15660