Skip to content
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

API Proposal: Previewers #36

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

API Proposal: Previewers #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
314bc14
Draft for preview API
bryphe Mar 7, 2018
bce6248
Preview API updates
bryphe Mar 21, 2018
2b08dc3
Merge master
bryphe Mar 21, 2018
f5f35f3
Finish merge
bryphe Mar 21, 2018
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
35 changes: 35 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,40 @@ export interface Configuration {
setValues(configurationValues: ConfigurationValues): void
}

export namespace Preview {
export interface PreviewContext {
filePath: string
language: string
}

/**
* Previewer
*
* Interface for a preview strategy
*/
export interface Previewer {
render(context: PreviewContext): JSX.Element
}

export interface Api {
/**
* Register a preview strategy
*/
registerPreviewer(identifier: string, previewer: Previewer): void

/**
* Set the default preview strategy for a filetype
*/
registerDefaultPreviewerForLanguage(language: string, previewIdentifier: string): void


/**
* Open the preview experience
*/
openPreview(openMode: FileOpenMode): Promise<void>
}
}

export namespace Notifications {

export interface Notification {
Expand Down Expand Up @@ -684,6 +718,7 @@ export namespace Plugin {
overlays: Overlays.Api
plugins: IPluginManager
menu: Menu.Api
preview: Preview.Api
process: Process
recorder: Recorder
snippets: Snippets.SnippetManager
Expand Down