Skip to content

doc(Driver): update documentation #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArgoZhang merged 1 commit into from
Jul 15, 2026
Merged

doc(Driver): update documentation #1072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 50 additions & 25 deletions src/components/BootstrapBlazor.DriverJs/Components/DriverJs.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,30 @@
namespace BootstrapBlazor.Components;

/// <summary>
/// FocusGuide 组件
/// <para lang="zh">DriverJs 组件</para>
/// <para lang="en">DriverJs component</para>
/// </summary>
public partial class DriverJs
{
/// <summary>
/// 获得/设置 是否自动开始向导 默认 true
/// <para lang="zh">获得/设置 是否自动开始向导，默认为 true</para>
/// <para lang="en">Gets or sets whether to start the tour automatically. Default is true</para>
/// </summary>
[Parameter]
[Obsolete("已弃用，删除即可；Deprecated, just delete it")]
[ExcludeFromCodeCoverage]
public bool AutoDrive { get; set; } = true;

/// <summary>
/// 获得/设置 组件配置 <see cref="DriverJsConfig"/> 实例 默认 null
/// <para lang="zh">获得/设置 组件配置 <see cref="DriverJsConfig"/> 实例，默认为 null</para>
/// <para lang="en">Gets or sets the <see cref="DriverJsConfig"/> instance. Default is null</para>
/// </summary>
[Parameter]
public DriverJsConfig? Config { get; set; }

/// <summary>
/// 获得/设置 子组件内容
/// <para lang="zh">获得/设置 子组件内容</para>
/// <para lang="en">Gets or sets the child content</para>
/// </summary>
[Parameter]
public RenderFragment? ChildContent { get; set; }
Expand All @@ -41,7 +45,8 @@ public partial class DriverJs
protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop);

/// <summary>
/// 开始方法
/// <para lang="zh">开始方法</para>
/// <para lang="en">Starts the tour</para>
/// </summary>
/// <returns></returns>
public async Task Start(int? index = 0)
Expand All @@ -60,7 +65,8 @@ public async Task Start(int? index = 0)
}

/// <summary>
/// 组件销毁前回调方法由 JavaScript 调用 返回 非空字符串时客户端 confirm 确认弹窗
/// <para lang="zh">组件销毁前回调方法由 JavaScript 调用 返回非空字符串时客户端 confirm 确认弹窗</para>
/// <para lang="en">Callback before the component is destroyed. Invoked by JavaScript. When a non-empty string is returned the client shows a confirm dialog</para>
/// </summary>
[JSInvokable]
public async Task<string?> OnBeforeDestroy(int index)
Expand All @@ -75,7 +81,8 @@ public async Task Start(int? index = 0)
}

/// <summary>
/// 组件销毁后回调方法由 JavaScript 调用
/// <para lang="zh">组件销毁后回调方法由 JavaScript 调用</para>
/// <para lang="en">Callback after the component is destroyed. Invoked by JavaScript</para>
/// </summary>
/// <returns></returns>
[JSInvokable]
Expand All @@ -88,7 +95,8 @@ public async Task OnDestroyed()
}

/// <summary>
/// 点击组件这招回调方法由 JavaScript 调用
/// <para lang="zh">点击遮罩回调方法由 JavaScript 调用</para>
/// <para lang="en">Callback when the overlay is clicked. Invoked by JavaScript</para>
/// </summary>
/// <returns></returns>
[JSInvokable]
Expand All @@ -101,68 +109,79 @@ public async Task OnOverlayClicked(int index)
}

/// <summary>
/// Starts at step 0
/// <para lang="zh">从指定步骤开始向导</para>
/// <para lang="en">Starts the tour at the specified step</para>
/// </summary>
/// <param name="index"></param>
/// <returns></returns>
public Task Drive(int? index) => InvokeVoidAsync("drive", Id, index);

/// <summary>
/// Move to the next step
/// <para lang="zh">移动到下一步</para>
/// <para lang="en">Moves to the next step</para>
/// </summary>
/// <returns></returns>
public Task MoveNext() => InvokeVoidAsync("moveNext", Id);

/// <summary>
/// Move to the previous step
/// <para lang="zh">移动到上一步</para>
/// <para lang="en">Moves to the previous step</para>
/// </summary>
/// <returns></returns>
public Task MovePrevious() => InvokeVoidAsync("movePrevious", Id);

/// <summary>
/// Move to the step
/// <para lang="zh">移动到指定步骤</para>
/// <para lang="en">Moves to the specified step</para>
/// </summary>
/// <returns></returns>
public Task MoveTo(int index) => InvokeVoidAsync("moveTo", Id, index);

/// <summary>
/// Is there a next step
/// <para lang="zh">是否存在下一步</para>
/// <para lang="en">Is there a next step</para>
/// </summary>
/// <returns></returns>
public Task<bool> HasNextStep() => InvokeAsync<bool>("hasNextStep", Id);

/// <summary>
/// Is there a previous step
/// <para lang="zh">是否存在上一步</para>
/// <para lang="en">Is there a previous step</para>
/// </summary>
/// <returns></returns>
public Task<bool> HasPreviousStep() => InvokeAsync<bool>("hasPreviousStep", Id);

/// <summary>
/// Is the current step the first step
/// <para lang="zh">当前步骤是否为第一步</para>
/// <para lang="en">Is the current step the first step</para>
/// </summary>
/// <returns></returns>
public Task<bool> IsFirstStep() => InvokeAsync<bool>("isFirstStep", Id);

/// <summary>
/// Is the current step the last step
/// <para lang="zh">当前步骤是否为最后一步</para>
/// <para lang="en">Is the current step the last step</para>
/// </summary>
/// <returns></returns>
public Task<bool> IsLastStep() => InvokeAsync<bool>("isLastStep", Id);

/// <summary>
/// Gets the active step index
/// <para lang="zh">获得当前步骤索引</para>
/// <para lang="en">Gets the active step index</para>
/// </summary>
/// <returns></returns>
public Task<int> GetActiveIndex() => InvokeAsync<int>("getActiveIndex", Id);

/// <summary>
/// Gets the active step index
/// <para lang="zh">销毁组件方法</para>
/// <para lang="en">Destroys the tour</para>
/// </summary>
/// <returns></returns>
public Task Destroy() => InvokeVoidAsync("destroy", Id);

/// <summary>
/// Gets the active step configuration
/// <para lang="zh">获得当前步骤配置</para>
/// <para lang="en">Gets the active step configuration</para>
/// </summary>
/// <returns></returns>
public async Task<DriverJsStep?> GetActiveStep()
Expand All @@ -178,7 +197,8 @@ public async Task OnOverlayClicked(int index)
}

/// <summary>
/// Gets the previous step configuration
/// <para lang="zh">获得上一步骤配置</para>
/// <para lang="en">Gets the previous step configuration</para>
/// </summary>
/// <returns></returns>
public async Task<DriverJsStep?> GetPreviousStep()
Expand All @@ -194,19 +214,22 @@ public async Task OnOverlayClicked(int index)
}

/// <summary>
/// Is the tour or highlight currently active
/// <para lang="zh">向导或高亮是否处于激活状态</para>
/// <para lang="en">Is the tour or highlight currently active</para>
/// </summary>
/// <returns></returns>
public Task<bool> IsActive() => InvokeAsync<bool>("isActive", Id);

/// <summary>
/// Recalculate and redraw the highlight
/// <para lang="zh">重新计算并绘制高亮区域</para>
/// <para lang="en">Recalculates and redraws the highlight</para>
/// </summary>
/// <returns></returns>
public Task Refresh() => InvokeVoidAsync("refresh", Id);

/// <summary>
/// Look at the DriveStep section of configuration for format of the step
/// <para lang="zh">高亮指定元素方法</para>
/// <para lang="en">Highlights the specified element. Look at the DriveStep section of configuration for format of the step</para>
/// </summary>
/// <param name="config"><see cref="DriverJsConfig"/> 实例</param>
/// <param name="selector">target selector</param>
Expand All @@ -221,7 +244,8 @@ public async Task Highlight(DriverJsConfig config, string? selector, DriverJsHig
}

/// <summary>
/// 添加步骤方法
/// <para lang="zh">添加步骤方法</para>
/// <para lang="en">Adds a step</para>
/// </summary>
/// <param name="step"></param>
public void AddStep(DriverJsStep step)
Expand All @@ -230,7 +254,8 @@ public void AddStep(DriverJsStep step)
}

/// <summary>
/// 移除步骤方法
/// <para lang="zh">移除步骤方法</para>
/// <para lang="en">Removes a step</para>
/// </summary>
/// <param name="step"></param>
public void RemoveStep(DriverJsStep step)
Expand Down
Loading
Loading