Home Docs

PdfReader

BitPdfReader is a simple pdf renderer utilizing the pdfjs library to bring pdf reading feature into Blazor world.

Notes

To use this component, you need to install the `Bit.BlazorUI.Extras` nuget package, as described in the Optional steps of the Getting started page.

Usage

Basic
RenderAllPages
Public API
   
/
   |

API

BitPdfReader parameters
Name
Type
Default value
Description
CanvasClass string? null The CSS class of the canvas element(s).
CanvasStyle string? null The CSS style of the canvas element(s).
Config BitPdfReaderConfig The configuration of the pdf reader.
Horizontal bool false Renders the pages horizontally.
InitialPageNumber int 1 The page number to render initially.
OnPdfPageRendered EventCallback The callback for when the pdf page is done rendering.
OnPdfLoaded EventCallback The callback for when the pdf document is done loading and processing.
RenderAllPages bool false Whether render all pages at start.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitPdfReaderConfig properties
Name
Type
Default value
Description
Id string Guid.NewGuid().ToString() The id of the pdf reader instance and its canvas element(s).
Url string The URL of the pdf file.
Scale decimal 1 The scale in which the pdf document gets rendered on the page.
AutoScale bool true Automatically scales the pdf based on the device pixel-ratio.
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.
  • On this page