fix: make dot children prop optional (#276)

* make dot children prop optional

* update typing for dot

Co-authored-by: Zhongde Liu <[email protected]>

Author: zhongdeliu

README.md

@@ -296,7 +296,7 @@ A Dot component is a HTML button.  Dots directly correlate to slides.  Clicking
 
 | property | type | default | required | purpose |
 | -------- | ---- | ------- | -------- | ------- |
-| **children** | [string|node] | | **Yes** | Children is a special React property.  Basically, the Dot component needs to wrap other components and/or JSX |
+| children | [string|null|node] | null | No | Children is a special React property.  Basically, the Dot component wraps other components and/or JSX |
 | className | [string|null] | null | No | Optional className string that will be appended to the component's className string. |
 | disabled | [boolean|null] | null | No | Null means Dot will automatically determine if this button is disabled. Setting this to true will force the button to be disabled.  Setting this to false will prevent the button from ever being disabled. |
 | onClick | [function|null] | null | No | Optional callback function that is called after the internal onClick function is called. It is passed the React synthetic event |

src/Dot/Dot.jsx

@@ -6,7 +6,7 @@ import s from './Dot.scss';
 const Dot = class Dot extends React.Component {
   static propTypes = {
     carouselStore: PropTypes.object.isRequired,
-    children: CarouselPropTypes.children.isRequired,
+    children: CarouselPropTypes.children,
     className: PropTypes.string,
     currentSlide: PropTypes.number.isRequired,
     disabled: PropTypes.bool,
@@ -18,6 +18,7 @@ const Dot = class Dot extends React.Component {
   }
 
   static defaultProps = {
+    children: null,
     className: null,
     disabled: null,
     onClick: null,

typings/carouselElements.d.ts

@@ -110,7 +110,7 @@ declare const DotGroup: DotGroupInterface
 
 
 interface DotProps {
-  readonly children: React.ReactChild
+  readonly children?: React.ReactChild
   readonly className?: string
   readonly disabled?: boolean
   readonly onClick?: () => void