Skip to content

Commit

Permalink
Merge bd24af8 into 7cee353
Browse files Browse the repository at this point in the history
  • Loading branch information
ryansolid committed May 30, 2021
2 parents 7cee353 + bd24af8 commit 898bd62
Show file tree
Hide file tree
Showing 99 changed files with 2,993 additions and 3,974 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ lib/
.vscode/
coverage/
types/
.DS_store
.DS_Store

packages/solid/src/jsx.d.ts
packages/solid/web/server/server.d.ts
Expand Down
20 changes: 18 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Changelog

## 1.0.0

### Breaking Changes

#### Options Objects

Most non-essential arguments on reactive primitives are now living on an options object. This was done to homogenize the API and make it easier to make future additions while remaining backwards compatible.

#### on

No longer uses rest parameters for multiple dependencies. Instead pass an array. This facilitates new option to defer execution until dependencies change.

#### Actions renamed to Directives

To remove future confusion with other uses of actions the JSX.Actions interace is now the JSX.Directives interface.

## 0.26.0 - 2021-04-09

This release is about finalizing some API changes on the road to 1.0. This one has one breaking change and not much else.
Expand Down Expand Up @@ -53,7 +69,7 @@ These are an escape hatch for unusual events. Previously these were custom attri

Now that we are supporting SSR for legacy(non-ESM) systems I need to use the main field to indicate a node env. We will be using the "browser" field for the client build in Solid. This straight up breaks Jest which doesn't respect that. I've created `solid-jest` to handle this.

https://github.com/solidui/solid-jest
https://github.com/solidjs/solid-jest

### New Features

Expand All @@ -63,7 +79,7 @@ Types added for Namespace attributes. You probably won't need most of these beca
```ts
declare module "solid-js" {
namespace JSX {
interface Actions { // use:____
interface Directives { // use:____

}
interface ExplicitProperties { // prop:____
Expand Down
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## <img src="https://raw.githubusercontent.com/solidjs/solid/main/assets/logo.png" alt="Solid" width="350"/><br>

[![Build Status](https://github.com/solidjs/solid/workflows/Solid%20CI/badge.svg)](https://github.com/solidjs/solid/actions/workflows/main-ci.yml)
[![Coverage Status](https://img.shields.io/coveralls/github/solidui/solid.svg?style=flat)](https://coveralls.io/github/solidui/solid?branch=main)
[![Coverage Status](https://img.shields.io/coveralls/github/solidjs/solid.svg?style=flat)](https://coveralls.io/github/solidjs/solid?branch=main)
[![NPM Version](https://img.shields.io/npm/v/solid-js.svg?style=flat)](https://www.npmjs.com/package/solid-js)
[![](https://img.shields.io/npm/dm/solid-js.svg?style=flat)](https://www.npmjs.com/package/solid-js)
[![Discord](https://img.shields.io/discord/722131463138705510)](https://discord.com/invite/solidjs)
Expand All @@ -20,6 +20,7 @@ Solid is a declarative JavaScript library for creating user interfaces. It does
- Small! Completely tree-shakeable Solid's compiler will only include parts of the library you use.
- Supports and is built on TypeScript.
- Supports modern features like JSX, Fragments, Context, Portals, Suspense, Streaming SSR, Progressive Hydration, Error Boundaries and Concurrent Rendering.
- Works in serverless environments including AWS Lambda and Cloudflare Workers.
- Webcomponent friendly and can author Custom Elements
- Context API that spans Custom Elements
- Implicit event delegation with Shadow DOM Retargeting
Expand Down Expand Up @@ -65,7 +66,7 @@ Want to see what code Solid generates:

### [Try it Online](https://playground.solidjs.com/)

## Getting Started
## Quick Start

> _`npm init solid <project-type> <project-name>` is available with npm 6+._
Expand Down Expand Up @@ -104,19 +105,19 @@ For TypeScript remember to set your TSConfig to handle Solid's JSX by:

## Documentation

- [Reactivity](https://github.com/solidjs/solid/blob/main/documentation/reactivity.md)
- [State](https://github.com/solidjs/solid/blob/main/documentation/state.md)
- [JSX Rendering](https://github.com/solidjs/solid/blob/main/documentation/rendering.md)
- [Components](https://github.com/solidjs/solid/blob/main/documentation/components.md)
- [Styling](https://github.com/solidjs/solid/blob/main/documentation/styling.md)
- [Context](https://github.com/solidjs/solid/blob/main/documentation/context.md)
- [Suspense](https://github.com/solidjs/solid/blob/main/documentation/suspense.md)
> This is the documentation for the 1.0.0 RC. THese are significantly slimmed down from what was here previously as we are moving things to the new Docs site. If you wish to see the older docs in the mean time [look here](https://github.com/solidjs/solid/tree/0.x/#documentation).
- [API](https://github.com/solidjs/solid/blob/main/documentation/api.md)
- [FAQ](https://github.com/solidjs/solid/blob/main/documentation/faq.md)
- [Comparison with other Libraries](https://github.com/solidjs/solid/blob/main/documentation/comparison.md)
- [Storybook](https://github.com/solidjs/solid/blob/main/documentation/storybook.md)

## Resources
### Guides
- [Getting Started](https://github.com/solidjs/solid/blob/main/documentation/guides/getting-started.md)
- [Reactivity](https://github.com/solidjs/solid/blob/main/documentation/guides/reactivity.md)
- [Rendering](https://github.com/solidjs/solid/blob/main/documentation/guides/rendering.md)
- [SSR](https://github.com/solidjs/solid/blob/main/documentation/guides/server.md)

### Resources

- [Examples](https://github.com/solidjs/solid/blob/main/documentation/resources/examples.md)
- [Articles](https://github.com/solidjs/solid/blob/main/documentation/resources/articles.md)
Expand Down Expand Up @@ -195,7 +196,3 @@ Become a sponsor and get your logo on our README on GitHub with a link to your s
<a href="https://opencollective.com/solid/sponsor/8/website" target="_blank"><img src="https://opencollective.com/solid/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/solid/sponsor/9/website" target="_blank"><img src="https://opencollective.com/solid/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/solid/sponsor/10/website" target="_blank"><img src="https://opencollective.com/solid/sponsor/10/avatar.svg"></a>

## Status

Solid is mostly feature complete for its v1.0.0 release. The next releases will be mostly bug fixes and API tweaks on the road to stability.
Loading

0 comments on commit 898bd62

Please sign in to comment.