API 参考

这是初始化driver后，driver提供的方法列表。

注意：为了简洁起见，我们省略了配置选项。请查看配置部分以获取选项。下面的描述中提供了链接。

import { driver } from "driver.js";
    import "driver.js/dist/driver.css";
    
    // Look at the configuration section for the options
    // https://driverjs.cn/docs/configuration#driver-configuration
    const driverObj = driver({ /* ... */ });
    
    // --------------------------------------------------
    // driverObj is an object with the following methods
    // --------------------------------------------------
    
    // Start the tour using `steps` given in the configuration
    driverObj.drive();  // Starts at step 0
    driverObj.drive(4); // Starts at step 4
    
    driverObj.moveNext(); // Move to the next step
    driverObj.movePrevious(); // Move to the previous step
    driverObj.moveTo(4); // Move to the step 4
    driverObj.hasNextStep(); // Is there a next step
    driverObj.hasPreviousStep() // Is there a previous step
    
    driverObj.isFirstStep(); // Is the current step the first step
    driverObj.isLastStep(); // Is the current step the last step
    
    driverObj.getActiveIndex(); // Gets the active step index
    
    driverObj.getActiveStep(); // Gets the active step configuration
    driverObj.getPreviousStep(); // Gets the previous step configuration
    driverObj.getActiveElement(); // Gets the active HTML element
    driverObj.getPreviousElement(); // Gets the previous HTML element
    
    // Is the tour or highlight currently active
    driverObj.isActive();
    
    // Recalculate and redraw the highlight
    driverObj.refresh();
    
    // Look at the configuration section for configuration options
    // https://driverjs.cn/docs/configuration#driver-configuration
    driverObj.getConfig();
    driverObj.setConfig({ /* ... */ });
    
    driverObj.setSteps([ /* ... */ ]); // Set the steps
    
    // Look at the state section of configuration for format of the state
    // https://driverjs.cn/docs/configuration#state
    driverObj.getState();
    
    // Look at the DriveStep section of configuration for format of the step
    // https://driverjs.cn/docs/configuration/#driver-step-configuration
    driverObj.highlight({ /* ... */ }); // Highlight an element
    
    driverObj.destroy(); // Destroy the tour