Skip to content

Commit

Permalink
chore(rename) Rename within code
Browse files Browse the repository at this point in the history
  • Loading branch information
berndartmueller committed Aug 15, 2020
1 parent 1177c66 commit e47e973
Show file tree
Hide file tree
Showing 13 changed files with 55 additions and 59 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Virtual Swiper</h3>
<h3 align="center">Virchual</h3>

<p align="center">
YOUR_SHORT_DESCRIPTION
Expand Down
6 changes: 3 additions & 3 deletions src/components/base-component.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import VirtualSwiper, { VirtualSwiperOptions, VirtualSwiperComponents } from './../virchual';
import Virchual, { VirchualOptions, VirchualComponents } from './../virchual';

export interface BaseComponentConstructor {
new (options: VirtualSwiperOptions): BaseComponent;
new (options: VirchualOptions): BaseComponent;
}

export interface BaseComponent {
mount(instance: VirtualSwiper, components: VirtualSwiperComponents): void;
mount(instance: Virchual, components: VirchualComponents): void;
}
8 changes: 4 additions & 4 deletions src/components/clone/clone.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { addClass, append, before, domify, remove, removeAttribute } from '../..
import TrackComponent from '../track/track.component';
import VirtualComponent from '../virtual/virtual.component';
import { LOOP } from './../../constants/types';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from './../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from './../../virchual';
import { BaseComponent } from './../base-component';
import { SlideComponent } from './../virtual/slide.component';

Expand All @@ -13,13 +13,13 @@ export default class CloneComponent implements BaseComponent {
private _clonesBefore: SlideComponent[] = [];
private _clonesAfter: SlideComponent[] = [];

private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private virtual: VirtualComponent;
private track: TrackComponent;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.virtual = components.Virtual as VirtualComponent;
this.track = components.Track as TrackComponent;
Expand Down
8 changes: 4 additions & 4 deletions src/components/controller/controller.component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { between } from '../../utils/utils';
import TrackComponent from '../track/track.component';
import { Event } from './../../core/event';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from './../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from './../../virchual';
import { BaseComponent } from './../base-component';

export default class ControllerComponent implements BaseComponent {
Expand All @@ -10,12 +10,12 @@ export default class ControllerComponent implements BaseComponent {
*/
private isLoop: boolean = true;

private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private track: TrackComponent;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.track = components.Track as TrackComponent;

Expand Down
8 changes: 4 additions & 4 deletions src/components/drag/drag.component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ControllerComponent from '../controller/controller.component';
import { BaseLayout } from '../layout/index';
import TrackComponent from '../track/track.component';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from './../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from './../../virchual';
import { BaseComponent } from './../base-component';

/**
Expand Down Expand Up @@ -35,11 +35,11 @@ export default class DragComponent implements BaseComponent {
private track: TrackComponent;
private layout: BaseLayout;
private controller: ControllerComponent;
private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.track = components.Track as TrackComponent;
this.layout = components.Layout as BaseLayout;
Expand Down
8 changes: 4 additions & 4 deletions src/components/layout/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { applyStyle } from '../../utils/dom';
import { throttle } from '../../utils/time';
import { unit } from '../../utils/utils';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from '../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from '../../virchual';
import { BaseComponent } from '../base-component';
import TrackComponent from '../track/track.component';
import VirtualComponent from '../virtual/virtual.component';
Expand All @@ -12,11 +12,11 @@ import VirtualComponent from '../virtual/virtual.component';
const THROTTLE = 100;

export abstract class BaseLayout implements BaseComponent {
protected swiperInstance: VirtualSwiper;
protected swiperInstance: Virchual;
protected track: TrackComponent;
protected virtual: VirtualComponent;

constructor(protected options: VirtualSwiperOptions) {}
constructor(protected options: VirchualOptions) {}

abstract initLayout();
abstract get listWidth(): number;
Expand All @@ -29,7 +29,7 @@ export abstract class BaseLayout implements BaseComponent {
abstract totalWidth(index: number): number;
abstract get width(): number;

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.virtual = components.Virtual as VirtualComponent;
this.track = components.Track as TrackComponent;
Expand Down
10 changes: 5 additions & 5 deletions src/components/pagination/pagination.component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { STATUS_CLASSES } from '../../constants/classes';
import { addClass, append, applyStyle, create, remove, removeClass } from '../../utils/dom';
import { unit } from '../../utils/utils';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from '../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from '../../virchual';
import ControllerComponent from '../controller/controller.component';
import VirtualComponent from '../virtual/virtual.component';
import { BaseComponent } from './../base-component';
Expand Down Expand Up @@ -29,13 +29,13 @@ export default class TrackComponent implements BaseComponent {

private virtual: VirtualComponent;
private controller: ControllerComponent;
private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private currentPosition: number;
private components: VirtualSwiperComponents;
private components: VirchualComponents;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.components = components;
this.virtual = components.Virtual as VirtualComponent;
Expand Down
4 changes: 2 additions & 2 deletions src/components/track/directions/horizontal.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { between } from '../../../utils/utils';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from '../../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from '../../../virchual';
import VirtualComponent from '../../virtual/virtual.component';
import { BaseLayout } from '../../layout/index';

Expand All @@ -17,7 +17,7 @@ export class HorizontalDirection {
private virtual: VirtualComponent;
private layout: BaseLayout;

constructor(private options: VirtualSwiperOptions, private instance: VirtualSwiper, private components: VirtualSwiperComponents) {
constructor(private options: VirchualOptions, private instance: Virchual, private components: VirchualComponents) {
this.virtual = components.Virtual as VirtualComponent;
this.layout = components.Layout as BaseLayout;
}
Expand Down
8 changes: 4 additions & 4 deletions src/components/track/track.component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { applyStyle } from '../../utils/dom';
import ControllerComponent from '../controller/controller.component';
import { SlideTransition } from './../../transitions/slide/index';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from './../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from './../../virchual';
import { BaseComponent } from './../base-component';
import { HorizontalDirection } from './directions/horizontal';

Expand All @@ -15,14 +15,14 @@ export default class TrackComponent implements BaseComponent {
// Whether the slider type is FADE or not.
private isFade: boolean = false;

private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private controller: ControllerComponent;
private _direction: HorizontalDirection;
private _list: HTMLElement;
private _track: HTMLElement;
private transition: SlideTransition;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

get direction() {
return this._direction;
Expand All @@ -36,7 +36,7 @@ export default class TrackComponent implements BaseComponent {
return this._track;
}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.controller = components.Controller as ControllerComponent;
this.transition = components.Transition as SlideTransition;
Expand Down
8 changes: 4 additions & 4 deletions src/components/virtual/slide.component.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { addClass, find, getAttribute, hasClass, removeClass, setAttribute } from '../../utils/dom';
import { values } from '../../utils/object';
import { pad } from '../../utils/utils';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from '../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from '../../virchual';
import TrackComponent from '../track/track.component';
import { STATUS_CLASSES } from './../../constants/classes';
import { TTB } from './../../constants/directions';
Expand All @@ -28,7 +28,7 @@ export class SlideComponent implements BaseComponent {
*/
private styles: string;

private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private track: TrackComponent;

/**
Expand All @@ -38,7 +38,7 @@ export class SlideComponent implements BaseComponent {
private statusUpdateEvents: string;

constructor(
private options: VirtualSwiperOptions,
private options: VirchualOptions,
public index: number,
public realIndex: number,
public slide: HTMLElement,
Expand All @@ -50,7 +50,7 @@ export class SlideComponent implements BaseComponent {
this.statusUpdateEvents = 'ready.slide updated.slide resize.slide ' + (this.options.updateOnMove ? 'move.slide' : 'moved.slide');
}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.track = components.Track as TrackComponent;

Expand Down
10 changes: 5 additions & 5 deletions src/components/virtual/virtual.component.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { SlideComponent } from './slide.component';
import VirtualSwiper, { VirtualSwiperOptions, VirtualSwiperComponents, VirtualSwiperSlide } from './../../virchual';
import Virchual, { VirchualOptions, VirchualComponents, VirchualSlide } from './../../virchual';
import { BaseComponent } from './../base-component';
import { domify, append, applyStyle } from '../../utils/dom';
import TrackComponent from '../track/track.component';
Expand All @@ -26,16 +26,16 @@ export default class VirtualComponent implements BaseComponent {
private virtualSlides: SlideComponent[];
private track: TrackComponent;
private layout: BaseLayout;
private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private previousFrom: number;
private previousTo: number;

constructor(private options: VirtualSwiperOptions) {
constructor(private options: VirchualOptions) {
this.previousFrom = 0;
this.previousTo = 0;
}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.track = components.Track as TrackComponent;
this.layout = components.Layout as BaseLayout;
Expand Down Expand Up @@ -114,7 +114,7 @@ export default class VirtualComponent implements BaseComponent {
}

private init() {
let slides: VirtualSwiperSlide[] = [];
let slides: VirchualSlide[] = [];
this.virtualSlides = [];

if (typeof this.options.slides === 'function') {
Expand Down
8 changes: 4 additions & 4 deletions src/transitions/slide/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import ControllerComponent from '../../components/controller/controller.component';
import TrackComponent from '../../components/track/track.component';
import { applyStyle } from '../../utils/dom';
import VirtualSwiper, { VirtualSwiperComponents, VirtualSwiperOptions } from '../../virchual';
import Virchual, { VirchualComponents, VirchualOptions } from '../../virchual';
import { BaseComponent } from './../../components/base-component';

export class SlideTransition implements BaseComponent {
Expand All @@ -16,12 +16,12 @@ export class SlideTransition implements BaseComponent {
private endCallback: Function;

private track: TrackComponent;
private swiperInstance: VirtualSwiper;
private swiperInstance: Virchual;
private controller: ControllerComponent;

constructor(private options: VirtualSwiperOptions) {}
constructor(private options: VirchualOptions) {}

mount(instance: VirtualSwiper, components: VirtualSwiperComponents) {
mount(instance: Virchual, components: VirchualComponents) {
this.swiperInstance = instance;
this.controller = components.Controller as ControllerComponent;
this.track = components.Track as TrackComponent;
Expand Down
26 changes: 11 additions & 15 deletions src/virchual.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ import { applyStyle, find } from './utils/dom';
import { error, exist } from './utils/error';
import { each } from './utils/object';

export type VirtualSwiperOptions = {
export type VirchualOptions = {
type?: 'slide' | 'loop';
slides?: VirtualSwiperSlides;
slides?: VirchualSlides;
rewindSpeed?: number;
speed?: number;
rewind?: boolean;
Expand Down Expand Up @@ -46,22 +46,18 @@ export type VirtualSwiperOptions = {
pagination?: boolean;
};

export type VirtualSwiperSlide = string | { key: string; html: string };
export type VirtualSwiperSlides = VirtualSwiperSlide[] | (() => VirtualSwiperSlide[]);
export type VirchualSlide = string | { key: string; html: string };
export type VirchualSlides = VirchualSlide[] | (() => VirchualSlide[]);

export type VirtualSwiperComponents = { [key: string]: BaseComponent };
export type VirchualComponents = { [key: string]: BaseComponent };

export default class VirtualSwiper {
export default class Virchual {
root: HTMLElement;

private _index: number;
private event: Event;

constructor(
public selector: HTMLElement | string,
public options: VirtualSwiperOptions = {},
private components: VirtualSwiperComponents = {},
) {
constructor(public selector: HTMLElement | string, public options: VirchualOptions = {}, private components: VirchualComponents = {}) {
this.root = selector instanceof Element ? selector : find(document, selector);

exist(this.root, 'An invalid element/selector was given.');
Expand Down Expand Up @@ -98,7 +94,7 @@ export default class VirtualSwiper {
...options,
};

const defaultComponents: VirtualSwiperComponents = {
const defaultComponents: VirchualComponents = {
Controller: new ControllerComponent(this.options),
Track: new TrackComponent(this.options),
Virtual: new VirtualComponent(this.options),
Expand Down Expand Up @@ -158,7 +154,7 @@ export default class VirtualSwiper {
*
* @return - This instance.
*/
on(events: string, handler: any, elm: (Window & typeof globalThis) | Element = null, options: object = {}): VirtualSwiper {
on(events: string, handler: any, elm: (Window & typeof globalThis) | Element = null, options: object = {}): Virchual {
this.event.on(events, handler, elm, options);

return this;
Expand All @@ -172,7 +168,7 @@ export default class VirtualSwiper {
*
* @return This instance.
*/
off(events: string, elm: (Window & typeof globalThis) | Element = null): VirtualSwiper {
off(events: string, elm: (Window & typeof globalThis) | Element = null): Virchual {
this.event.off(events, elm);

return this;
Expand Down Expand Up @@ -222,7 +218,7 @@ export default class VirtualSwiper {
}

[].forEach.call(document.querySelectorAll('.image-swiper'), (slider: HTMLElement) => {
const instance = new VirtualSwiper(slider, {
const instance = new Virchual(slider, {
slides: () => {
const slides: { key: string; html: string }[] = [];

Expand Down

0 comments on commit e47e973

Please sign in to comment.