You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Under the hood, react-flickity-component uses a [React Portal](https://reactjs.org/docs/portals.html) to render children slides inside a Flickity instance. The need for a portal is because after Flickity is initialized, new DOM nodes (mostly Flickity wrapper elements) would be created, this changes the DOM hierarchy of the parent component, thus any future update, whether it's originated from Flickity, like adding/removing slides, or from parent, like a prop changes, will make React fail to reconcile for the DOM snapshot is out of sync.
79
79
80
-
#64 introduced a new prop to change the underlying render method: instead of portal, react-flickity-component will directly render children. This is create a smoother server-side rendering experience, but **please be aware using `static` prop possibly will cause all your future update to fail,** which means adding/removing slides will definitely fail to render, so use with caution.
80
+
[#64](https://github.com/yaodingyd/react-flickity-component/pull/64) introduced a new prop to change the underlying render method: instead of using portal, react-flickity-component will directly render children. This is to create a smoother server-side rendering experience, but **please be aware using `static` prop possibly will cause all your future update to fail,** which means adding/removing slides will definitely fail to render, so use with caution.
81
81
82
-
However there is a fail-safe option `reloadOnUpdate`. It means every time there is a update, we tear down and set up Flickity. This will ensure that Flickity is always rendered correctly, but it's a rather costly operation and it will cause a flicker since DOM nodes are destroyed and recreated.
82
+
However there is a fail-safe option `reloadOnUpdate`. It means every time there is a update, we tear down and set up Flickity. This will ensure that Flickity is always rendered correctly, but it's a rather costly operation and it **will cause a flicker** since DOM nodes are destroyed and recreated. Please also note it means any update, either rerender of the parent, or any of the props change, will always cause an update in the Flickity component. For more information, see a detailed explanation and workaround in [#147](https://github.com/yaodingyd/react-flickity-component/issues/147).
83
83
84
84
85
85
### Use Flickity's API and events
86
86
87
87
You can access the Flickity instance with `flickityRef` prop just like `ref`, and use this instance to register events and use API.
88
88
89
89
```javascript
90
+
// function component
91
+
functionCarousel () {
92
+
constref=React.useRef(null);
90
93
94
+
function myCustomNext = () {
95
+
// You can use Flickity API
96
+
ref.current.next()
97
+
}
98
+
99
+
React.useEffect(() => {
100
+
if (ref.current) {
101
+
ref.current.on("settle", () => {
102
+
console.log(`current index is ${ref.current.selectedIndex}`);
103
+
});
104
+
}
105
+
}, []);
91
106
107
+
return (
108
+
<Flickity flickityRef={c=>ref.current= c}>
109
+
<img src="/images/placeholder.png"/>
110
+
<img src="/images/placeholder.png"/>
111
+
<img src="/images/placeholder.png"/>
112
+
</Flickity>
113
+
<Button onClick={myCustomNext}>My custom next button</Button>
114
+
)
115
+
}
116
+
// class component
92
117
classCarouselextendsReact.Component {
93
118
94
119
componentDidMount= () => {
@@ -114,7 +139,6 @@ class Carousel extends React.Component {
0 commit comments