Merge pull request #35 from vadimkorr/feature/#33_Change-pages-programmatically

Feature/#33 Change pages programmatically

Author: vadimkorr

.npmignore

@@ -8,4 +8,6 @@ storybook-static
 # dist
 scripts
 
-.test.js
+src/**/*.test.js
+
+DEPLOYMENT.md

.storybook/preview.js

@@ -1,3 +1,4 @@
+import './styles.css'
 
 export const parameters = {
   actions: { argTypesRegex: "^on[A-Z].*" },

.storybook/styles.css

@@ -0,0 +1,47 @@
+.sb-container {
+  padding: 10px;
+  border-radius: 5px;
+  background-color: #d2d2d2;
+}
+
+span.sb-title {
+  color: #3e3e3e;
+  display: block;
+  margin: 5px;
+  font-size: 16px;
+  font-family: Arial, Helvetica, sans-serif;
+}
+
+.sb-divider {
+  max-width: 100%;
+  border-bottom: solid 3px #ffffff;
+  margin: 5px;
+  box-sizing: border-box;
+}
+
+.sb-button {
+  width: 150px;
+  height: 35px;
+  margin: 5px;
+  padding: 0px 10px;
+  border-radius: 5px;
+  background-color: #009800;
+  border: none;
+  color: white;
+  text-decoration: none;
+  font-size: 14px;
+  cursor: pointer;
+}
+
+.sb-input[type=text],
+.sb-input[type=number] {
+  width: 150px;
+  height: 35px;
+  margin: 5px;
+  padding: 0px 10px;
+  border-radius: 5px;
+  display: inline-block;
+  border: 1px solid #9f9f9f;
+  outline: none;
+  box-sizing: border-box;
+}

DEPLOYMENT.md

@@ -0,0 +1,14 @@
+# How to publish new feature:
+
+1. Update unit tests
+2. Update storybook
+
+3. Update version in `package.json`
+
+4. Update docs in `README.md`
+5. Update docs in `src/docs`
+6. `yarn build:docs`
+
+7. `npm publish`
+8. Merge feature branch
+9. Create release in GitHub

README.md

@@ -137,4 +137,85 @@ Slot props:
   </div>
   <!-- -->
 </Carousel>
-```
+```
+
+## Methods
+
+### `goTo`
+Navigates to a page by index
+
+Arguments:
+
+| Argument           | Type        | Default | Description                           | 
+|--------------------|-------------|---------|---------------------------------------|
+| `pageIndex`        | `number`    |         | Page number                           |
+| `options.animated` | `boolean`   | `true`  | Should it be animated or not          |
+
+```jsx
+<script>
+  // ...
+  let carousel;
+  function goToStartPage() {
+    carousel.goTo(0, { animated: false })
+  }
+</script>
+
+<Carousel
+  bind:this={carousel}
+>
+  <!--  -->
+</Carousel>
+<button class="button" on:click={goToStartPage}>Go</button>
+```
+
+### `goToPrev`
+Navigates to the previous page
+
+Arguments:
+
+| Argument           | Type        | Default | Description                           | 
+|--------------------|-------------|---------|---------------------------------------|
+| `options.animated` | `boolean`   | `true`  | Should it be animated or not          |
+
+```jsx
+<script>
+  // ...
+  let carousel;
+  function goToPrevPage() {
+    carousel.goToPrev({ animated: false })
+  }
+</script>
+
+<Carousel
+  bind:this={carousel}
+>
+  <!--  -->
+</Carousel>
+<button class="button" on:click={goToPrevPage}>Go</button>
+```
+
+### `goToNext`
+Navigates to the next page
+
+Arguments:
+
+| Argument           | Type        | Default | Description                           | 
+|--------------------|-------------|---------|---------------------------------------|
+| `options.animated` | `boolean`   | `true`  | Should it be animated or not          |
+
+```jsx
+<script>
+  // ...
+  let carousel;
+  function goToNextPage() {
+    carousel.goToNext({ animated: false })
+  }
+</script>
+
+<Carousel
+  bind:this={carousel}
+>
+  <!--  -->
+</Carousel>
+<button class="button" on:click={goToNextPage}>Go</button>
+```