Skip to content

Specifying Typescript specific prop types #431

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Specifying Typescript specific prop types #431

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f488113
Specifying Typescript specific prop types
muthu1712 Jul 3, 2021
5494193
Introduce BasicProps config
muthu1712 Jul 11, 2021
bec5bbe
Rename BasicProps to CommonProps
muthu1712 Jul 17, 2021
9b6d49b
bump version 2.6.1
muthu1712 Jul 17, 2021
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ const MyReport = ({ accessToken, embedUrl, embedId }) => {
embedUrl: embedUrl,
embedId: embedId,
reportMode: "View", // "Edit"
permissions: "View", // "All" (when using "Edit" mode)
permissions: "Read", // "All" (when using "Edit" mode)
extraSettings: {
filterPaneEnabled: false,
navContentPaneEnabled: false,
Expand Down Expand Up @@ -305,7 +305,7 @@ const simulateAjaxCall = new Promise(function(resolve, reject) {
embedUrl: "embedUrl",
embedId: "embedId",
reportMode: "View", // "Edit"
permissions: "View", // "All" (when using "Edit" mode)
permissions: "Read", // "All" (when using "Edit" mode)
});
});

Expand Down Expand Up @@ -339,7 +339,7 @@ const MyReport = ({ accessToken, embedUrl, embedId }) => {
return (
<div className="report-container">
<div className="report" ref={reportRef} />
<button onClick={getMyConfiguraionFromServer}>Get config from AJAX call</button>
<button onClick={getMyConfigurationFromServer}>Get config from AJAX call</button>
</div>
);
};
Expand Down
16 changes: 9 additions & 7 deletions src/lib/hooks/useReport.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,20 @@ import {
createEmbedConfigBasedOnEmbedType,
validateBootrapConfig
} from '../utils/config';
import { Config } from '../types';
import { Config, ConfigProps } from '../types';
import { Embed } from 'embed';

declare type UseReport = [any, (ref: any, config: Config) => void];
declare type _UseReport = [any, (ref: any, config: Config) => void];

declare type UseBootstrap = [any, (ref: any, config: Config) => void, (ref: any, config: Config) => void];
declare type UseReport = [any, (ref: any, config: ConfigProps) => void];

declare type UseBootstrap = [any, (ref: any, config: ConfigProps) => void, (ref: any, config: ConfigProps) => void];

// powerbi object is global
// used inside Embed.jsx has more logic tied to props of Embed.
function _useReport(
performOnEmbed: (report: any, reportRef?: any) => void
): UseReport {
): _UseReport {
const [report, _setEmbedInstance] = useState<Embed | null>(null);

const setEmbed = (embedDivRef: any, embedConfig: Config): void => {
Expand Down Expand Up @@ -54,7 +56,7 @@ function _useReport(
function useReport(): UseReport {
const [report, _setEmbedInstance] = useState<Embed | null>(null);

const embed = (ref: any, config: Config): void => {
const embed = (ref: any, config: ConfigProps): void => {
const embedConfig = createEmbedConfigBasedOnEmbedType(config);
const errors = validateConfig(embedConfig);
if (!errors || errors.length === 0) {
Expand All @@ -75,7 +77,7 @@ function useBootstrap(): UseBootstrap {
const [isBotstrapped, setIsBootstrapped] = useState<Boolean>(false);
const [report, _setEmbedInstance] = useState<Embed | null>(null);

const embed = (ref: any, config: Config): void => {
const embed = (ref: any, config: ConfigProps): void => {
if(isBotstrapped) {
const embedConfig = createEmbedConfigBasedOnEmbedType(config);
const errors = validateConfig(embedConfig);
Expand All @@ -92,7 +94,7 @@ function useBootstrap(): UseBootstrap {
}
};

const bootstrap = (ref: any, config: Config) => {
const bootstrap = (ref: any, config: ConfigProps) => {
const bootstrapConfig = createEmbedConfigBasedOnEmbedType(config);
if (validateBootrapConfig(bootstrapConfig)) {
window.powerbi.bootstrap(ref.current, bootstrapConfig);
Expand Down
2 changes: 2 additions & 0 deletions src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ export interface Config {
dashboardId: string;
}

export type ConfigProps = ReportProps | DashboardProps | TileProps | ReportVisualProps;

export interface Embed {
config: Config;
performOnEmbed: (report: any, reportRef?: any) => void;
Expand Down