Merge pull request #12 from faceless-ui/chore/dotnav

chore: renames DotsNav to DotNav

demo/FreeScrollSliderDemo/index.tsx

@@ -5,7 +5,7 @@ import {
   SliderNav,
   SliderProgress,
   SliderTrack,
-  DotsNav
+  DotNav
 } from '../../src'; // swap '../../src' for '../../dist' to demo production build
 
 const FreeScrollSliderDemo: React.FC = () => (
@@ -120,7 +120,7 @@ const FreeScrollSliderDemo: React.FC = () => (
           }}
         />
       </div>
-      <DotsNav
+      <DotNav
         buttonProps={{
           style: {
             width: '5px',

src/DotsNav/index.tsx → src/DotNav/index.tsx

@@ -1,14 +1,14 @@
 import React, { HTMLProps } from 'react';
 import useSlider from '../useSlider';
 
-export interface DotsNavProps extends HTMLProps<HTMLElement> {
+export interface DotNavProps extends HTMLProps<HTMLElement> {
   htmlElement?: React.ElementType
   dotClassName?: string
   activeDotClassName?: string
   buttonProps?: HTMLProps<HTMLButtonElement>
 }
 
-const DotsNav: React.FC<DotsNavProps> = (props) => {
+const DotNav: React.FC<DotNavProps> = (props) => {
   const {
     htmlElement: Tag = 'div',
     dotClassName,
@@ -66,4 +66,4 @@ const DotsNav: React.FC<DotsNavProps> = (props) => {
   );
 };
 
-export default DotsNav;
+export default DotNav;

src/index.ts

@@ -1,4 +1,3 @@
-export { default as DotsNav } from './DotsNav';
 export { default as Slide } from './Slide';
 export { default as SliderProvider } from './SliderProvider';
 export { default as SliderContext } from './SliderProvider/context';
@@ -8,3 +7,7 @@ export { default as SliderProgress } from './SliderProgress';
 export { default as SliderTrack } from './SliderTrack';
 export { default as useSlider } from './useSlider';
 export { default as withSlider } from './withSlider';
+export {
+  default as DotNav,
+  default as DotsNav // for backward compatibility
+} from './DotNav';

src/types.ts

@@ -3,5 +3,8 @@ export { SliderSettings, SliderProviderProps } from './SliderProvider';
 export { ISlide, SlideProps } from './Slide';
 export { SliderProgressProps, ProgressIndicatorProps } from './SliderProgress';
 export { SliderButtonProps } from './SliderButton';
-export { DotsNavProps } from './DotsNav';
 export { SliderTrackProps } from './SliderTrack';
+export {
+  DotNavProps,
+  DotNavProps as DotsNavProps  // for backward compatibility
+} from './DotNav';