https://github.com/abritopach/st-3d-card-carousel
Sample project that shows an experimental 3D card carousel Web Component built with Stencil.
https://github.com/abritopach/st-3d-card-carousel
stencil stencil-components stenciljs stenciljs-components web-components webcomponents
Last synced: about 1 year ago
JSON representation
Sample project that shows an experimental 3D card carousel Web Component built with Stencil.
- Host: GitHub
- URL: https://github.com/abritopach/st-3d-card-carousel
- Owner: abritopach
- License: mit
- Created: 2019-06-11T11:22:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-11T18:20:01.000Z (about 6 years ago)
- Last Synced: 2025-04-01T20:31:36.315Z (about 1 year ago)
- Topics: stencil, stencil-components, stenciljs, stenciljs-components, web-components, webcomponents
- Language: TypeScript
- Homepage:
- Size: 28.9 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Stencil 3D Card Carousel
[](https://github.com/abritopach) [](https://www.npmjs.com/package/st-three-dimensional-card-carousel) [](https://www.npmjs.com/package/st-three-dimensional-card-carousel)
**If this project has been useful to you and you want to help me to keep contributing to the open source with projects, examples, plugins,... collaborate and buy me a coffee.**
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](https://github.com/ionic-team/stencil-app-starter) instead.
# Stencil
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.
## Component preview
## Slides model
Slides: CardItem[] interface.
```bash
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'
}];
```
## Component properties
| 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`
## Component events
| Event | Description | Type |
| ---------------------- | ----------- | ------------------ |
| `currentItem` | | `CustomEvent` |
| `reachBeginningSlides` | | `CustomEvent` |
| `reachEndSlides` | | `CustomEvent` |
| `selectedItem` | | `CustomEvent` |
| `slideChange` | | `CustomEvent` |
| `slideDoubleTap` | | `CustomEvent` |
## Component public API methods
### `addSlide(index: number, slides: CardItem | CardItem[]) => Promise`
```bash
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);
```
#### Returns
Type: `Promise`
### `appendSlide(slides: CardItem[]) => Promise`
```bash
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);
```
#### Returns
Type: `Promise`
### `cycle() => Promise`
```bash
Restarts cycling through the slides from left to right.
```
#### Returns
Type: `Promise`
### `getActiveIndex() => Promise`
```bash
Get the index of the active slide.
```
#### Returns
Type: `Promise`
### `getNextIndex() => Promise`
```bash
Get the index of the next slide.
```
#### Returns
Type: `Promise`
### `getPreviousIndex() => Promise`
```bash
Get the index of the previous slide.
```
#### Returns
Type: `Promise`
### `isBeginning() => Promise`
```bash
Get whether or not the current slide is the first slide.
```
#### Returns
Type: `Promise`
### `isEnd() => Promise`
```bash
Get whether or not the current slide is the last slide.
```
#### Returns
Type: `Promise`
### `length() => Promise`
```bash
Get the total number of slides.
```
#### Returns
Type: `Promise`
### `loadMore() => Promise`
#### Returns
Type: `Promise`
### `moreSlides() => Promise`
#### Returns
Type: `Promise`
### `next() => Promise`
```bash
Navigates to the next slide.
```
#### Returns
Type: `Promise`
### `prependSlide(slides: CardItem | CardItem[]) => Promise`
```bash
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);
```
#### Returns
Type: `Promise`
### `prev() => Promise`
```bash
Navigates to the previous slide.
```
#### Returns
Type: `Promise`
### `reloadSlides() => Promise`
#### Returns
Type: `Promise`
### `removeAllSlides() => Promise`
#### Returns
Type: `Promise`
### `removeSlide(slideIndex: number | number[]) => Promise`
#### Returns
Type: `Promise`
### `select(slideId: string | number) => Promise`
```bash
Go to specific slide by number or keywords.
.select(3);
.select('prev');
.select('next');
.select('first');
.select('last');
```
#### Returns
Type: `Promise`
### `slideReset() => Promise`
```bash
Reset swiper position to initial slide.
```
#### Returns
Type: `Promise`
## Getting Started
Before you go through this component, you should have at least a basic understanding of Stencil concepts.
```bash
git clone https://github.com/abritopach/st-3d-card-carousel
cd st-3d-card-carousel
```
and run:
```bash
npm install
npm start
```
To build the component for production, run:
```bash
npm run build
```
To run the unit tests for the components, run:
```bash
npm test
```
## Naming Components
When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: ``). 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`.
## Using this component
### Ionic / Angular project
1) Install the package.
```bash
npm install st-three-dimensional-card-carousel --save
```
2) Modify main.ts to import and make a call to defineCustomElements.
```bash
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)
```
3) Add the CUSTOM_ELEMENTS_SCHEMA.
```bash
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 {}
```
4) Use 3D card carousel web component in html
```bash
```
### Vue project
1) Install the package.
```bash
npm install st-three-dimensional-card-carousel --save
```
2) Modify main.js to import and make a call to defineCustomElements.
```bash
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')
```
3) Use 3D card carousel web component in jsx
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.
```bash
```
### Example Ionic project
- Component in Ionic project: https://github.com/abritopach/ionic-employees-stitch-mongodb
### Example Angular project
- Component in Angular project: https://github.com/abritopach/angular-architecture
### Example React project
### Example Vue project
- Component in Vue project: https://github.com/abritopach/vue-stencil-3d-card-carousel
### Script tag
- [NPM](https://www.npmjs.com/package/st-three-dimensional-card-carousel)
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
### Node Modules
- Run `npm install st-three-dimensional-card-carousel --save`
- Put a script tag similar to this `` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
### In a stencil-starter app
- Run `npm install st-three-dimensional-card-carousel --save`
- Add an import to the npm packages `import st-three-dimensional-card-carousel;`
- Then you can use the element anywhere in your template, JSX, html etc