st-three-dimensional-card-carousel
Advanced tools
Experimental 3D card carousel Web Component built with Stencil.
Sample project that shows an experimental 3D card carousel Web Component built with Stencil. A framework-agnostic web component that works in Ionic, Angular, React, Vue,...
Stencil is also great for building entire apps. For that, use the stencil-app-starter instead.
Stencil is a compiler for building fast web apps using Web Components.
Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.
Stencil components are just Web Components, so they work in any major framework or with no framework at all.
Slides: CardItem[] interface.
INTERFACE
export interface CardItem {
id: number;
title: string;
description?: string;
subtitle?: {
text: string;
icon?: string;
};
color: string;
imgUrl: string;
backgroundImgUrl?: string;
footer?: {
icons: {
leftIcon: string;
rightIcon: string;
},
values: {
leftValue: number;
rightValue: number;
}
},
currentPlacement: number;
}
EXAMPLE SLIDES
slides = [{
id: 1,
title: 'User 1',
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#1abc9c',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'http://oxygennacdn3.oxygenna.com/wp-content/uploads/2015/11/18.jpg',
footer: {
icons: {
leftIcon: "fa fa-users",
rightIcon: "fa fa-comments"
},
values: {
leftValue:12,
rightValue: 4
}
}
},
{
id: 2,
title: 'User 2',
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin placerat molestie euismod. Etiam tincidunt luctus diam non ullamcorper. Maecenas eros est, iaculis hendrerit imperdiet nec, rhoncus in turpis. Vestibulum elementum mauris vitae nibh sagittis, et fermentum nunc aliquet. Donec sed ex sollicitudin, tristique sapien non, lacinia enim.',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://s-media-cache-ak0.pinimg.com/originals/d2/7b/4f/d27b4fa995194a0c77b8871a326a7c0b.jpg'
}];
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
allowSwipeSlide | -- | { prev: boolean; next: boolean; } | { prev: true, next: true } | |
animationSelectedSlide | animation-selected-slide | boolean | true | |
autoloop | -- | { enabled: boolean; seconds: number; direction: string; } | { enabled: false, seconds: 2000, direction: 'right' } | |
axis | axis | string | 'horizontal' | |
controls | -- | { enabled: boolean; position: string; text: string[]; } | { enabled: false, position: 'top', text: ['prev', 'next'] } | |
distance | distance | number | undefined | |
initialSlide | initial-slide | number | 1 | |
keyboard | keyboard | boolean | false | |
slideStyle | -- | {} | { } | |
slides | -- | CardItem[] | [] | |
slidesToShow | slides-to-show | number | 6 |
| Event | Description | Type |
|---|---|---|
currentItem | CustomEvent<any> | |
reachBeginningSlides | CustomEvent<any> | |
reachEndSlides | CustomEvent<any> | |
selectedItem | CustomEvent<any> | |
slideChange | CustomEvent<any> | |
slideDoubleTap | CustomEvent<any> |
addSlide(index: number, slides: CardItem | CardItem[]) => Promise<CardItem[]>Add new slides to the required index. Slides could be new slide or array with such slides.
const newSlides = [
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://ak2.picdn.net/shutterstock/videos/19300069/thumb/9.jpg'
},
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e74c3c',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'http://oxygennacdn1.oxygenna.com/wp-content/uploads/2017/01/header-image-6.jpg'
}
];
.addSlide(newSlides);
Type: Promise<CardItem[]>
appendSlide(slides: CardItem[]) => Promise<CardItem[]>Add new slide / slides to the end. Slides could be new slide or array with such slides.
const newSlides = [
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://ak2.picdn.net/shutterstock/videos/19300069/thumb/9.jpg'
},
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e74c3c',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'http://oxygennacdn1.oxygenna.com/wp-content/uploads/2017/01/header-image-6.jpg'
},
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://ak2.picdn.net/shutterstock/videos/19300069/thumb/9.jpg'
},
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e74c3c',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'http://oxygennacdn1.oxygenna.com/wp-content/uploads/2017/01/header-image-6.jpg'
},
];
const newSlide = {
id: 18,
title: 'User 18',
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://ak2.picdn.net/shutterstock/videos/19300069/thumb/9.jpg'
}
.appendSlide(newSlides);
.appendSlide(newSlide);
Type: Promise<CardItem[]>
cycle() => Promise<boolean>Restarts cycling through the slides from left to right.
Type: Promise<boolean>
getActiveIndex() => Promise<number>Get the index of the active slide.
Type: Promise<number>
getNextIndex() => Promise<number>Get the index of the next slide.
Type: Promise<number>
getPreviousIndex() => Promise<number>Get the index of the previous slide.
Type: Promise<number>
isBeginning() => Promise<boolean>Get whether or not the current slide is the first slide.
Type: Promise<boolean>
isEnd() => Promise<boolean>Get whether or not the current slide is the last slide.
Type: Promise<boolean>
length() => Promise<number>Get the total number of slides.
Type: Promise<number>
loadMore() => Promise<CardItem[]>Type: Promise<CardItem[]>
moreSlides() => Promise<boolean>Type: Promise<boolean>
next() => Promise<CardItem>Navigates to the next slide.
Type: Promise<CardItem>
prependSlide(slides: CardItem | CardItem[]) => Promise<CardItem[]>Add new slide / slides to the beginning. Slides could be new slide or array with such slides.
const newSlides = [
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e67e22',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'https://ak2.picdn.net/shutterstock/videos/19300069/thumb/9.jpg'
},
{
id: Math.floor(Math.random() * 100),
title: 'User ' + Math.random().toString(36).substr(2, 4),
description: 'Wait a minute. Wait a minute, Doc. Uhhh...',
subtitle: {
text: 'Spain',
icon: "fa fa-flag"
},
color: '#e74c3c',
currentPlacement: 0,
imgUrl: 'https://www.resa.es/wp-content/uploads/2015/07/icon-user-default.png',
backgroundImgUrl: 'http://oxygennacdn1.oxygenna.com/wp-content/uploads/2017/01/header-image-6.jpg'
}
];
.prependSlide(newSlides);
Type: Promise<CardItem[]>
prev() => Promise<CardItem>Navigates to the previous slide.
Type: Promise<CardItem>
reloadSlides() => Promise<CardItem[]>Type: Promise<CardItem[]>
removeAllSlides() => Promise<CardItem[]>Type: Promise<CardItem[]>
removeSlide(slideIndex: number | number[]) => Promise<CardItem[]>Type: Promise<CardItem[]>
select(slideId: string | number) => Promise<CardItem>Go to specific slide by number or keywords.
.select(3);
.select('prev');
.select('next');
.select('first');
.select('last');
Type: Promise<CardItem>
slideReset() => Promise<CardItem>Reset swiper position to initial slide.
Type: Promise<CardItem>
Before you go through this component, you should have at least a basic understanding of Stencil concepts.
git clone https://github.com/abritopach/st-3d-card-carousel
cd st-3d-card-carousel
and run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
When creating new component tags, we recommend not using stencil in the component name (ex: <stencil-datepicker>). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion.
npm install st-three-dimensional-card-carousel --save
import { enableProdMode } from '@angular/core'
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'
import { AppModule } from './app/app.module'
import { environment } from './environments/environment'
import { defineCustomElements } from 'st-three-dimensional-card-carousel/dist/loader'
if (environment.production) {
enableProdMode()
}
platformBrowserDynamic()
.bootstrapModule(AppModule)
.catch(err => console.log(err))
defineCustomElements(window)
import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'
import { CommonModule } from '@angular/common'
import { IonicModule } from '@ionic/angular'
import { FormsModule } from '@angular/forms'
import { RouterModule } from '@angular/router'
import { HomePage } from './home.page'
@NgModule({
imports: [
CommonModule,
FormsModule,
IonicModule,
RouterModule.forChild([
{
path: '',
component: HomePage,
},
]),
],
schemas: [CUSTOM_ELEMENTS_SCHEMA],
declarations: [HomePage],
})
export class HomePageModule {}
<st-3D-card-carousel [slides]="slides" [autoloop]="autoloop" [distance]="slideDistance" (selectedItem)="handleSelectedItem($event)"
(slideChange)="handleSlideChange($event)"></st-3D-card-carousel>
npm install st-three-dimensional-card-carousel --save
import Vue from 'vue'
import App from './App.vue'
import { defineCustomElements, applyPolyfills } from 'st-three-dimensional-card-carousel/loader';
Vue.config.productionTip = false
// tell Vue to ignore all components defined in the st-three-dimensional-card-carousel/loader
// package. The regex assumes all components names are prefixed.
// 'st'
Vue.config.ignoredElements = [/st-\w*/];
// Bind the custom elements to the window object.
applyPolyfills().then(() => {
defineCustomElements(window);
});
new Vue({
render: h => h(App),
}).$mount('#app')
Vue provides a way to explicitly pass the object as a property rather than an attribute, it is as simple as adding .prop to the property name of the stencil component.
<st-3D-card-carousel v-bind:slides.prop="slides" v-bind:autoloop.prop="autoloop"></st-3D-card-carousel>
<script src='https://unpkg.com/st-three-dimensional-card-carousel@0.0.1/dist/st-three-dimensional-card-carousel.js'></script> in the head of your index.htmlnpm install st-three-dimensional-card-carousel --save<script src='node_modules/my-component/dist/st-three-dimensional-card-carousel.js'></script> in the head of your index.htmlnpm install st-three-dimensional-card-carousel --saveimport st-three-dimensional-card-carousel;FAQs
Experimental 3D card carousel Web Component built with Stencil.
The npm package st-three-dimensional-card-carousel receives a total of 8 weekly downloads. As such, st-three-dimensional-card-carousel popularity was classified as not popular.
We found that st-three-dimensional-card-carousel demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.