@@ -12,7 +12,7 @@ class Flicking extends Component
1212
1313<div className="container">
1414 <div className="row mb-2"><div className="col col--4"><strong>Properties</strong></div><div className="col col--4"><strong>Methods</strong></div><div className="col col--4"><strong>Events</strong></div></div>
15- <div className="row"><div className="col col--4"><a href="#VERSION">VERSION</a><span className="badge badge--info margin-left--sm">static</span><br/><a href="#control">control</a><br/><a href="#camera">camera</a><br/><a href="#renderer">renderer</a><br/><a href="#viewport">viewport</a><br/><a href="#autoResizer">autoResizer</a><br/><a href="#initialized">initialized</a><br/><a href="#circularEnabled">circularEnabled</a><br/><a href="#virtualEnabled">virtualEnabled</a><br/><a href="#index">index</a><br/><a href="#element">element</a><br/><a href="#currentPanel">currentPanel</a><br/><a href="#panels">panels</a><br/><a href="#panelCount">panelCount</a><br/><a href="#visiblePanels">visiblePanels</a><br/><a href="#animating">animating</a><br/><a href="#holding">holding</a><br/><a href="#activePlugins">activePlugins</a><br/><a href="#align">align</a><br/><a href="#defaultIndex">defaultIndex</a><br/><a href="#horizontal">horizontal</a><br/><a href="#circular">circular</a><br/><a href="#circularFallback">circularFallback</a><br/><a href="#bound">bound</a><br/><a href="#adaptive">adaptive</a><br/><a href="#panelsPerView">panelsPerView</a><br/><a href="#noPanelStyleOverride">noPanelStyleOverride</a><br/><a href="#resizeOnContentsReady">resizeOnContentsReady</a><br/><a href="#nested">nested</a><br/><a href="#needPanelThreshold">needPanelThreshold</a><br/><a href="#preventEventsBeforeInit">preventEventsBeforeInit</a><br/><a href="#deceleration">deceleration</a><br/><a href="#easing">easing</a><br/><a href="#duration">duration</a><br/><a href="#inputType">inputType</a><br/><a href="#moveType">moveType</a><br/><a href="#threshold">threshold</a><br/><a href="#dragThreshold">dragThreshold</a><br/><a href="#interruptable">interruptable</a><br/><a href="#bounce">bounce</a><br/><a href="#iOSEdgeSwipeThreshold">iOSEdgeSwipeThreshold</a><br/><a href="#preventClickOnDrag">preventClickOnDrag</a><br/><a href="#preventDefaultOnDrag">preventDefaultOnDrag</a><br/><a href="#disableOnInit">disableOnInit</a><br/><a href="#changeOnHold">changeOnHold</a><br/><a href="#renderOnlyVisible">renderOnlyVisible</a><br/><a href="#virtual">virtual</a><br/><a href="#autoInit">autoInit</a><br/><a href="#autoResize">autoResize</a><br/><a href="#useResizeObserver">useResizeObserver</a><br/><a href="#observePanelResize">observePanelResize</a><br/><a href="#resizeDebounce">resizeDebounce</a><br/><a href="#maxResizeDebounce">maxResizeDebounce</a><br/><a href="#useFractionalSize">useFractionalSize</a><br/><a href="#externalRenderer">externalRenderer</a><br/><a href="#renderExternal">renderExternal</a><br/><a href="#optimizeSizeUpdate">optimizeSizeUpdate</a></div><div className="col col--4"><a href="#init">init</a><br/><a href="#destroy">destroy</a><br/><a href="#prev">prev</a><br/><a href="#next">next</a><br/><a href="#moveTo">moveTo</a><br/><a href="#updateAnimation">updateAnimation</a><br/><a href="#stopAnimation">stopAnimation</a><br/><a href="#getPanel">getPanel</a><br/><a href="#enableInput">enableInput</a><br/><a href="#disableInput">disableInput</a><br/><a href="#getStatus">getStatus</a><br/><a href="#setStatus">setStatus</a><br/><a href="#addPlugins">addPlugins</a><br/><a href="#removePlugins">removePlugins</a><br/><a href="#resize">resize</a><br/><a href="#append">append</a><br/><a href="#prepend">prepend</a><br/><a href="#insert">insert</a><br/><a href="#remove">remove</a><br/><a href="#trigger">trigger</a><br/><a href="#once">once</a><br/><a href="#hasOn">hasOn</a><br/><a href="#on">on</a><br/><a href="#off">off</a></div><div className="col col--4"><a href="#event-ready">ready</a><br/><a href="#event-beforeResize">beforeResize</a><br/><a href="#event-afterResize">afterResize</a><br/><a href="#event-holdStart">holdStart</a><br/><a href="#event-holdEnd">holdEnd</a><br/><a href="#event-moveStart">moveStart</a><br/><a href="#event-move">move</a><br/><a href="#event-moveEnd">moveEnd</a><br/><a href="#event-willChange">willChange</a><br/><a href="#event-changed">changed</a><br/><a href="#event-willRestore">willRestore</a><br/><a href="#event-restored">restored</a><br/><a href="#event-select">select</a><br/><a href="#event-needPanel">needPanel</a><br/><a href="#event-visibleChange">visibleChange</a><br/><a href="#event-reachEdge">reachEdge</a><br/><a href="#event-panelChange">panelChange</a></div></div>
15+ <div className="row"><div className="col col--4"><a href="#VERSION">VERSION</a><span className="badge badge--info margin-left--sm">static</span><br/><a href="#control">control</a><br/><a href="#camera">camera</a><br/><a href="#renderer">renderer</a><br/><a href="#viewport">viewport</a><br/><a href="#autoResizer">autoResizer</a><br/><a href="#initialized">initialized</a><br/><a href="#circularEnabled">circularEnabled</a><br/><a href="#virtualEnabled">virtualEnabled</a><br/><a href="#index">index</a><br/><a href="#element">element</a><br/><a href="#currentPanel">currentPanel</a><br/><a href="#panels">panels</a><br/><a href="#panelCount">panelCount</a><br/><a href="#visiblePanels">visiblePanels</a><br/><a href="#animating">animating</a><br/><a href="#holding">holding</a><br/><a href="#activePlugins">activePlugins</a><br/><a href="#align">align</a><br/><a href="#defaultIndex">defaultIndex</a><br/><a href="#horizontal">horizontal</a><br/><a href="#circular">circular</a><br/><a href="#circularFallback">circularFallback</a><br/><a href="#bound">bound</a><br/><a href="#adaptive">adaptive</a><br/><a href="#panelsPerView">panelsPerView</a><br/><a href="#noPanelStyleOverride">noPanelStyleOverride</a><br/><a href="#resizeOnContentsReady">resizeOnContentsReady</a><br/><a href="#nested">nested</a><br/><a href="#needPanelThreshold">needPanelThreshold</a><br/><a href="#preventEventsBeforeInit">preventEventsBeforeInit</a><br/><a href="#deceleration">deceleration</a><br/><a href="#easing">easing</a><br/><a href="#duration">duration</a><br/><a href="#inputType">inputType</a><br/><a href="#moveType">moveType</a><br/><a href="#threshold">threshold</a><br/><a href="#dragThreshold">dragThreshold</a><br/><a href="#animationThreshold">animationThreshold</a><br/><a href="#useCSSOrder">useCSSOrder</a><br/><a href="#interruptable">interruptable</a><br/><a href="#bounce">bounce</a><br/><a href="#iOSEdgeSwipeThreshold">iOSEdgeSwipeThreshold</a><br/><a href="#preventClickOnDrag">preventClickOnDrag</a><br/><a href="#preventDefaultOnDrag">preventDefaultOnDrag</a><br/><a href="#disableOnInit">disableOnInit</a><br/><a href="#changeOnHold">changeOnHold</a><br/><a href="#renderOnlyVisible">renderOnlyVisible</a><br/><a href="#virtual">virtual</a><br/><a href="#autoInit">autoInit</a><br/><a href="#autoResize">autoResize</a><br/><a href="#useResizeObserver">useResizeObserver</a><br/><a href="#observePanelResize">observePanelResize</a><br/><a href="#resizeDebounce">resizeDebounce</a><br/><a href="#maxResizeDebounce">maxResizeDebounce</a><br/><a href="#useFractionalSize">useFractionalSize</a><br/><a href="#externalRenderer">externalRenderer</a><br/><a href="#renderExternal">renderExternal</a><br/><a href="#optimizeSizeUpdate">optimizeSizeUpdate</a></div><div className="col col--4"><a href="#init">init</a><br/><a href="#destroy">destroy</a><br/><a href="#prev">prev</a><br/><a href="#next">next</a><br/><a href="#moveTo">moveTo</a><br/><a href="#updateAnimation">updateAnimation</a><br/><a href="#stopAnimation">stopAnimation</a><br/><a href="#getPanel">getPanel</a><br/><a href="#enableInput">enableInput</a><br/><a href="#disableInput">disableInput</a><br/><a href="#getStatus">getStatus</a><br/><a href="#setStatus">setStatus</a><br/><a href="#addPlugins">addPlugins</a><br/><a href="#removePlugins">removePlugins</a><br/><a href="#resize">resize</a><br/><a href="#append">append</a><br/><a href="#prepend">prepend</a><br/><a href="#insert">insert</a><br/><a href="#remove">remove</a></div><div className="col col--4"><a href="#event-ready">ready</a><br/><a href="#event-beforeResize">beforeResize</a><br/><a href="#event-afterResize">afterResize</a><br/><a href="#event-holdStart">holdStart</a><br/><a href="#event-holdEnd">holdEnd</a><br/><a href="#event-moveStart">moveStart</a><br/><a href="#event-move">move</a><br/><a href="#event-moveEnd">moveEnd</a><br/><a href="#event-willChange">willChange</a><br/><a href="#event-changed">changed</a><br/><a href="#event-willRestore">willRestore</a><br/><a href="#event-restored">restored</a><br/><a href="#event-select">select</a><br/><a href="#event-needPanel">needPanel</a><br/><a href="#event-visibleChange">visibleChange</a><br/><a href="#event-reachEdge">reachEdge</a><br/><a href="#event-panelChange">panelChange</a></div></div>
1616</div>
1717
1818## constructor
@@ -613,6 +613,36 @@ const flicking = new Flicking({
613613** See** :
614614- [ dragThreshold ( Options )] ( https://naver.github.io/egjs-flicking/Options#dragThreshold )
615615
616+ ### animationThreshold { #animationThreshold }
617+
618+ <div >
619+
620+ </div >
621+
622+ animation이 진행되기 위한 최소한의 거리. 이동하려는 거리가 ` animationThreshold ` 보다 적으면 애니메이션 없이(duration: 0) 즉시 이동한다.
623+
624+ ** Type** : number
625+
626+ ** Default** : 0.5
627+
628+ ** See** :
629+ - [ animationThreshold ( Options )] ( https://naver.github.io/egjs-flicking/Options#animationThreshold )
630+
631+ ### useCSSOrder { #useCSSOrder }
632+
633+ <div >
634+
635+ </div >
636+
637+ ` useCSSOrder ` 를 사용하면 DOM의 순서는 변경되지 않지만 ` order ` css가 설정되면서 화면상 순서가 바뀐다. (` circular ` 를 사용한 경우 위치에 따라 DOM의 순서가 변경된다.)<br />` iframe ` 을 사용하는 경우 DOM의 순서가 변경되면서 reload가 되는 것을 막을 수 있다.<br />svelte에서는 css order를 무조건 사용한다.
638+
639+ ** Type** : boolean
640+
641+ ** Default** : false
642+
643+ ** See** :
644+ - [ useCSSOrder ( Options )] ( https://naver.github.io/egjs-flicking/Options#useCSSOrder )
645+
616646### interruptable { #interruptable }
617647
618648<div >
@@ -1153,7 +1183,7 @@ const samePanel = flicking.panels[0];
11531183
11541184패널 및 뷰포트의 크기를 갱신합니다
11551185
1156- ** Returns** : this
1186+ ** Returns** : boolean
11571187
11581188** Emits** : [ Flicking#event:beforeResize] ( Flicking#event-beforeResize ) , [ Flicking#event:afterResize] ( Flicking#event-afterResize )
11591189
@@ -1263,183 +1293,6 @@ flicking.insert(3, "\<div\>Panel 1\</div\>\<div\>Panel 2\</div\>");
12631293| index| number||| 제거할 패널의 인덱스|
12641294| deleteCount| number| ✔️| 1| ` index ` 이후로 제거할 패널의 개수|
12651295
1266- ### trigger { #trigger }
1267-
1268- <div >
1269- <span className = " badge badge--danger" >inherited</span >
1270- </div >
1271-
1272- 커스텀 이벤트를 발생시킨다
1273-
1274- ** Returns** : this
1275- - 컴포넌트 자신의 인스턴스
1276-
1277- | PARAMETER| TYPE| OPTIONAL| DEFAULT| DESCRIPTION|
1278- | :---:| :---:| :---:| :---:| :---:|
1279- | event| string \| ComponentEvent||| 발생할 커스텀 이벤트의 이름 또는 ComponentEvent의 인스턴스|
1280- | params| Array< ; any> ; \| $ts:...||| 커스텀 이벤트가 발생할 때 전달할 데이터|
1281-
1282- ``` ts
1283- import Component , { ComponentEvent } from " @egjs/component" ;
1284-
1285- class Some extends Component <{
1286- beforeHi: ComponentEvent <{ foo: number ; bar: string }>;
1287- hi: { foo: { a: number ; b: boolean } };
1288- someEvent: (foo : number , bar : string ) => void ;
1289- someOtherEvent: void ; // When there's no event argument
1290- }> {
1291- some(){
1292- if (this .trigger (" beforeHi" )){ // When event call to stop return false.
1293- this .trigger (" hi" );// fire hi event.
1294- }
1295- }
1296- }
1297-
1298- const some = new Some ();
1299- some .on (" beforeHi" , e => {
1300- if (condition ){
1301- e .stop (); // When event call to stop, `hi` event not call.
1302- }
1303- // `currentTarget` is component instance.
1304- console .log (some === e .currentTarget ); // true
1305-
1306- typeof e .foo ; // number
1307- typeof e .bar ; // string
1308- });
1309- some .on (" hi" , e => {
1310- typeof e .foo .b ; // boolean
1311- });
1312- // If you want to more know event design. You can see article.
1313- // https://github.com/naver/egjs-component/wiki/How-to-make-Component-event-design%3F
1314- ```
1315-
1316- ### once { #once }
1317-
1318- <div >
1319- <span className = " badge badge--danger" >inherited</span >
1320- </div >
1321-
1322- 이벤트가 한번만 실행된다.
1323-
1324- ** Returns** : this
1325- - 컴포넌트 자신의 인스턴스
1326-
1327- | PARAMETER| TYPE| OPTIONAL| DEFAULT| DESCRIPTION|
1328- | :---:| :---:| :---:| :---:| :---:|
1329- | eventName| string \| $ts:...||| 등록할 이벤트의 이름 또는 이벤트 이름-핸들러 오브젝트|
1330- | handlerToAttach| function \| $ts:...| ✔️|| 등록할 이벤트의 핸들러 함수|
1331-
1332- ``` ts
1333- import Component , { ComponentEvent } from " @egjs/component" ;
1334-
1335- class Some extends Component <{
1336- hi: ComponentEvent ;
1337- }> {
1338- hi() {
1339- alert (" hi" );
1340- }
1341- thing() {
1342- this .once (" hi" , this .hi );
1343- }
1344- }
1345-
1346- var some = new Some ();
1347- some .thing ();
1348- some .trigger (new ComponentEvent (" hi" ));
1349- // fire alert("hi");
1350- some .trigger (new ComponentEvent (" hi" ));
1351- // Nothing happens
1352- ```
1353-
1354- ### hasOn { #hasOn }
1355-
1356- <div >
1357- <span className = " badge badge--danger" >inherited</span >
1358- </div >
1359-
1360- 컴포넌트에 이벤트가 등록됐는지 확인한다.
1361-
1362- ** Returns** : boolean
1363- - 이벤트 등록 여부
1364-
1365- | PARAMETER| TYPE| OPTIONAL| DEFAULT| DESCRIPTION|
1366- | :---:| :---:| :---:| :---:| :---:|
1367- | eventName| string||| 등록 여부를 확인할 이벤트의 이름|
1368-
1369- ``` ts
1370- import Component from " @egjs/component" ;
1371-
1372- class Some extends Component <{
1373- hi: void ;
1374- }> {
1375- some() {
1376- this .hasOn (" hi" );// check hi event.
1377- }
1378- }
1379- ```
1380-
1381- ### on { #on }
1382-
1383- <div >
1384- <span className = " badge badge--danger" >inherited</span >
1385- </div >
1386-
1387- 컴포넌트에 이벤트를 등록한다.
1388-
1389- ** Returns** : this
1390- - 컴포넌트 자신의 인스턴스
1391-
1392- | PARAMETER| TYPE| OPTIONAL| DEFAULT| DESCRIPTION|
1393- | :---:| :---:| :---:| :---:| :---:|
1394- | eventName| string \| $ts:...||| 등록할 이벤트의 이름 또는 이벤트 이름-핸들러 오브젝트|
1395- | handlerToAttach| function \| $ts:...| ✔️|| 등록할 이벤트의 핸들러 함수|
1396-
1397- ``` ts
1398- import Component , { ComponentEvent } from " @egjs/component" ;
1399-
1400- class Some extends Component <{
1401- hi: void ;
1402- }> {
1403- hi() {
1404- console .log (" hi" );
1405- }
1406- some() {
1407- this .on (" hi" ,this .hi ); // attach event
1408- }
1409- }
1410- ```
1411-
1412- ### off { #off }
1413-
1414- <div >
1415- <span className = " badge badge--danger" >inherited</span >
1416- </div >
1417-
1418- 컴포넌트에 등록된 이벤트를 해제한다.<br />` eventName ` 이 주어지지 않았을 경우 모든 이벤트 핸들러를 제거한다.<br />` handlerToAttach ` 가 주어지지 않았을 경우 ` eventName ` 에 해당하는 모든 이벤트 핸들러를 제거한다.
1419-
1420- ** Returns** : this
1421- - 컴포넌트 자신의 인스턴스
1422-
1423- | PARAMETER| TYPE| OPTIONAL| DEFAULT| DESCRIPTION|
1424- | :---:| :---:| :---:| :---:| :---:|
1425- | eventName| string \| $ts:...| ✔️|| 해제할 이벤트의 이름|
1426- | handlerToDetach| function \| $ts:...| ✔️|| 해제할 이벤트의 핸들러 함수|
1427-
1428- ``` ts
1429- import Component , { ComponentEvent } from " @egjs/component" ;
1430-
1431- class Some extends Component <{
1432- hi: void ;
1433- }> {
1434- hi() {
1435- console .log (" hi" );
1436- }
1437- some() {
1438- this .off (" hi" ,this .hi ); // detach event
1439- }
1440- }
1441- ```
1442-
14431296## Events
14441297### ready { #event - ready }
14451298
0 commit comments