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.

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
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
105 changes: 105 additions & 0 deletions index.d.ts
@@ -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";
Copy link
Collaborator

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 with any.


/**
* 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;
}
}
1 change: 1 addition & 0 deletions no-important.d.ts
@@ -0,0 +1 @@
export * from "aphrodite";
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -8,6 +8,7 @@
"inline-styles"
],
"main": "lib/index.js",
"types": "index.d.ts",
"scripts": {
"lint": "eslint --fix --cache . && flow check",
"test": "npm run coverage",
Expand Down Expand Up @@ -74,4 +75,4 @@
"tests"
]
}
}
}