|
| 1 | +// Copyright (c) Argo Zhang (argo@163.com). All rights reserved. |
| 2 | +// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. |
| 3 | +// Website: https://www.blazor.zone or https://argozhang.github.io/ |
| 4 | + |
| 5 | +using Microsoft.AspNetCore.Components; |
| 6 | + |
| 7 | +namespace BootstrapBlazor.Components; |
| 8 | + |
| 9 | +/// <summary> |
| 10 | +/// Represents a viewer component for displaying Office documents in a web application. |
| 11 | +/// </summary> |
| 12 | +/// <remarks>The <see cref="OfficeViewer"/> component allows users to display Office files such as Word, |
| 13 | +/// Excel, or PowerPoint documents. It provides configurable options for the document URL, viewer height, and a callback |
| 14 | +/// for when the document is loaded.</remarks> |
| 15 | +public partial class OfficeViewer |
| 16 | +{ |
| 17 | + /// <summary> |
| 18 | + /// Gets or sets the url for the Office file to be displayed. |
| 19 | + /// </summary> |
| 20 | + [Parameter] |
| 21 | + public string? Url { get; set; } |
| 22 | + |
| 23 | + /// <summary> |
| 24 | + /// Gets or sets the viewer height. Default is null. |
| 25 | + /// </summary> |
| 26 | + [Parameter] |
| 27 | + public string? Height { get; set; } |
| 28 | + |
| 29 | + /// <summary> |
| 30 | + /// Gets or sets the document loaded event callback. |
| 31 | + /// </summary> |
| 32 | + [Parameter] |
| 33 | + public Func<Task>? OnLoaded { get; set; } |
| 34 | + |
| 35 | + [Inject, NotNull] |
| 36 | + private NavigationManager? NavigationManager { get; set; } |
| 37 | + |
| 38 | + private string? ClassString => CssBuilder.Default("bb-office-viewer-container") |
| 39 | + .AddClassFromAttributes(AdditionalAttributes) |
| 40 | + .Build(); |
| 41 | + |
| 42 | + private string? StyleString => CssBuilder.Default() |
| 43 | + .AddClass($"--bb-office-viewer-height: {Height};", !string.IsNullOrEmpty(Height)) |
| 44 | + .Build(); |
| 45 | + |
| 46 | + private string? _url; |
| 47 | + |
| 48 | + /// <summary> |
| 49 | + /// <inheritdoc/> |
| 50 | + /// </summary> |
| 51 | + /// <param name="firstRender"></param> |
| 52 | + /// <returns></returns> |
| 53 | + protected override async Task OnAfterRenderAsync(bool firstRender) |
| 54 | + { |
| 55 | + await base.OnAfterRenderAsync(firstRender); |
| 56 | + |
| 57 | + if (firstRender) |
| 58 | + { |
| 59 | + _url = Url; |
| 60 | + return; |
| 61 | + } |
| 62 | + |
| 63 | + var rerender = false; |
| 64 | + if (_url != Url) |
| 65 | + { |
| 66 | + _url = Url; |
| 67 | + rerender = true; |
| 68 | + } |
| 69 | + |
| 70 | + if (rerender) |
| 71 | + { |
| 72 | + await InvokeVoidAsync("load", Id, GetAbsoluteUri(_url)); |
| 73 | + } |
| 74 | + } |
| 75 | + |
| 76 | + /// <summary> |
| 77 | + /// <inheritdoc/> |
| 78 | + /// </summary> |
| 79 | + /// <returns></returns> |
| 80 | + protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop, new |
| 81 | + { |
| 82 | + LoadedCallaback = nameof(TriggerOnLoaded), |
| 83 | + Url = GetAbsoluteUri(Url) |
| 84 | + }); |
| 85 | + |
| 86 | + private string GetAbsoluteUri(string? url) |
| 87 | + { |
| 88 | + url ??= string.Empty; |
| 89 | + if (string.IsNullOrEmpty(url)) |
| 90 | + { |
| 91 | + return url; |
| 92 | + } |
| 93 | + var uri = NavigationManager.ToAbsoluteUri(url); |
| 94 | + return uri.AbsoluteUri; |
| 95 | + } |
| 96 | + |
| 97 | + /// <summary> |
| 98 | + /// Trigger OnLoaded callback when the PDF document is loaded. |
| 99 | + /// </summary> |
| 100 | + /// <returns></returns> |
| 101 | + [JSInvokable] |
| 102 | + public async Task TriggerOnLoaded() |
| 103 | + { |
| 104 | + if (OnLoaded != null) |
| 105 | + { |
| 106 | + await OnLoaded(); |
| 107 | + } |
| 108 | + } |
| 109 | +} |
0 commit comments