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.
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
Updated Typescript definitions and included in package #258
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Type definitions for Aphrodite 1.2.3 | ||
// Project: https://github.com/Khan/aphrodite | ||
|
||
declare module "aphrodite" { | ||
import * as React from "react"; | ||
|
||
/** | ||
* Aphrodite style declaration | ||
*/ | ||
export interface StyleDeclaration | ||
{ | ||
[key: string]: React.CSSProperties; | ||
} | ||
|
||
interface StyleSheetStatic | ||
{ | ||
/** | ||
* Create style sheet | ||
*/ | ||
create( styles: StyleDeclaration ): StyleDeclaration; | ||
create<T extends StyleDeclaration>( styles: T ): T; | ||
/** | ||
* Rehydrate class names from server renderer | ||
*/ | ||
rehydrate( renderedClassNames: string[] ): void; | ||
} | ||
|
||
export var StyleSheet: StyleSheetStatic; | ||
|
||
type CSSInputTypes = ( StyleDeclaration | false | null | void ); | ||
|
||
/** | ||
* Get class names from passed styles | ||
*/ | ||
export function css( ...styles: CSSInputTypes[] ): string; | ||
|
||
interface StaticRendererResult | ||
{ | ||
html: string; | ||
css: { | ||
content: string; | ||
renderedClassNames: string[]; | ||
} | ||
} | ||
|
||
/** | ||
* Utilities for using Aphrodite server-side. | ||
*/ | ||
interface StyleSheetServerStatic | ||
{ | ||
renderStatic( renderFunc: () => string ): StaticRendererResult; | ||
} | ||
|
||
export var StyleSheetServer: StyleSheetServerStatic; | ||
|
||
interface StyleSheetTestUtilsStatic | ||
{ | ||
/** | ||
* Prevent styles from being injected into the DOM. | ||
* | ||
* This is useful in situations where you'd like to test rendering UI | ||
* components which use Aphrodite without any of the side-effects of | ||
* Aphrodite happening. Particularly useful for testing the output of | ||
* components when you have no DOM, e.g. testing in Node without a fake DOM. | ||
* | ||
* Should be paired with a subsequent call to | ||
* clearBufferAndResumeStyleInjection. | ||
*/ | ||
suppressStyleInjection(): void; | ||
/** | ||
* Opposite method of preventStyleInject. | ||
*/ | ||
clearBufferAndResumeStyleInjection(): void; | ||
} | ||
|
||
export var StyleSheetTestUtils: StyleSheetTestUtilsStatic; | ||
|
||
export interface SelectorHandler | ||
{ | ||
( selector: string, baseSelector: string, callback: ( selector: string ) => string ): string | null; | ||
} | ||
|
||
export interface Extension | ||
{ | ||
selectorHandler?: SelectorHandler, | ||
} | ||
|
||
/** | ||
* Calling StyleSheet.extend() returns an object with each of the exported | ||
* properties on it. | ||
*/ | ||
interface Exports | ||
{ | ||
css( ...styles: CSSInputTypes[] ): string; | ||
|
||
StyleSheet: StyleSheetStatic; | ||
StyleSheetServer: StyleSheetServerStatic; | ||
StyleSheetTestUtils: StyleSheetTestUtilsStatic; | ||
} | ||
|
||
interface StyleSheetStatic | ||
{ | ||
extend( extensions: Extension[] ): Exports; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
export * from "aphrodite"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've been using TypeScript & Aphrodite for a side project, and had to use my own copy because I'm using Aphrodite but not react -- can you remove this, since Aphrodite doesn't have a dependency on React? As an initial pass, it should be fine to just replace
React.CSSProperties
withany
.