Skip to content

Feat/add NullstackFunctionalComponent type #273

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

Merged
Mortaro merged 3 commits into from
Dec 4, 2022
Merged

Feat/add NullstackFunctionalComponent type #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
059af8f
add FC type
mayconfsousa Aug 30, 2022
6fa1fae
Rename from FC to NullstackFunctionalComponent
mayconfsousa Aug 30, 2022
e34146e
Merge branch 'unstable-next' into feat/functional-component-type
Mortaro Dec 4, 2022
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
1 change: 1 addition & 0 deletions types/ClientContext.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,5 +126,6 @@ export type NullstackClientContext<TProps = unknown> = TProps & {
*
* @see https://nullstack.app/refs#complex-refable-components
*/

element?: HTMLElement
}
12 changes: 7 additions & 5 deletions types/JSX.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface Attributes {
[key: string]: any
}

export type NullstackAttributes = Attributes
export interface NullstackAttributes extends Attributes {}

export interface ClassAttributes extends Attributes {
key?: string
Expand All @@ -69,7 +69,7 @@ export interface ClassAttributes extends Attributes {

type DetailedHTMLFactory<P, T = any> = P

export interface SVGFactory { }
export interface SVGFactory {}

export type NullstackFragment = NullstackNode[]
export type NullstackNode = NullstackFragment | string | number | boolean | null | undefined
Expand Down Expand Up @@ -101,6 +101,7 @@ export interface BaseSyntheticEvent<E = object, C = any, T = any> {
* This might be a child element to the element on which the event listener is registered.
* If you thought this should be `EventTarget & T`, see https://github.com/DefinitelyTyped/DefinitelyTyped/issues/11508#issuecomment-256045682
*/

export type SyntheticEvent<T = Element, E = Event> = BaseSyntheticEvent<E, EventTarget & T, EventTarget>

export interface DragEvent<T = Element> extends MouseEvent<T, NativeDragEvent> {
Expand Down Expand Up @@ -196,6 +197,7 @@ export interface WheelEvent<T = Element> extends MouseEvent<T, NativeWheelEvent>
type EventHandler<E extends SyntheticEvent<any>> =
| object
| {

bivarianceHack(event: { event: E } & NullstackClientContext): void
}['bivarianceHack']

Expand All @@ -216,7 +218,7 @@ type WheelEventHandler<T = Element> = EventHandler<WheelEvent<T>>

type DetailedHTMLProps<E extends HTMLAttributes<T>, T> = E

export interface SVGProps<T> extends SVGAttributes<T>, ClassAttributes { }
export interface SVGProps<T> extends SVGAttributes<T>, ClassAttributes {}

export interface DOMAttributes<T> extends Attributes {
// Focus Events
Expand Down Expand Up @@ -305,7 +307,7 @@ export interface DOMAttributes<T> extends Attributes {

// All the WAI-ARIA 1.1 attributes from https://www.w3.org/TR/wai-aria-1.1/
export interface AriaAttributes {
/** Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or applicatio */
/** Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application */
'aria-activedescendant'?: string
/** Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. */
'aria-atomic'?: Booleanish
Expand Down Expand Up @@ -1423,6 +1425,6 @@ declare global {
element: ElementTagHTMLAttributes
}

interface IntrinsicElements extends ExoticElements, AllElements { }
interface IntrinsicElements extends ExoticElements, AllElements {}
}
}
22 changes: 22 additions & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,28 @@ export * from './Settings.d.ts'
export * from './Worker.d.ts'
export * from './JSX.d.ts'

/**
* Functional component
*
* @example
*
* ```
* import { NullstackClientContext, NullstackFunctionalComponent } from 'nullstack';
*
* interface InputProps {
* label: string;
* }
*
* function Input({ label, page }: NullstackClientContext<InputProps>) {
* console.log(page.title);
* return <p>{label}</p>;
* }
*
* export default Input as NullstackFunctionalComponent<InputProps>;
* ```
*/
export type NullstackFunctionalComponent<TProps> = (props: TProps) => NullstackNode;

export default class Nullstack<TProps = unknown> {

constructor(props?: TProps)
Expand Down