Skip to content

Commit

Permalink
Format md files
Browse files Browse the repository at this point in the history
  • Loading branch information
mefechoel committed May 29, 2020
1 parent 66be397 commit 46e1628
Show file tree
Hide file tree
Showing 5 changed files with 286 additions and 144 deletions.
1 change: 1 addition & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module.exports = {
trailingComma: "all",
svelteBracketNewLine: true,
proseWrap: "always",
};
43 changes: 29 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,23 @@
- `Router` now automatically manages focus in your app
- It focuses an appropriate heading, when changing `Route`s
- It makes an announcement to screen reader users when changing `Route`s
- You can customize which element should be focused after the `Route` transition via the `useFocus` hook
- You can customize the screen reader announcement via the `a11y.createAnnouncement` prop
- You can customize which element should be focused after the `Route`
transition via the `useFocus` hook
- You can customize the screen reader announcement via the
`a11y.createAnnouncement` prop
- `Route`s can now be nested
- The `useParams` hook allows access to url params, matched by the parent `Route`
- The `useParams` hook allows access to url params, matched by the parent
`Route`
- The `useResolvable` hook allows to subscribe to a resolved path

## Breaking:

- Link props and getProps return value will be merged, with getProps taking precedent
- Path resolution now does not treat the base of a nested Router as an absolute base any more
- The `useActiveRoute` has been removed. You should use `useMatch` or `useParams` instead
- Link props and getProps return value will be merged, with getProps taking
precedent
- Path resolution now does not treat the base of a nested Router as an absolute
base any more
- The `useActiveRoute` has been removed. You should use `useMatch` or
`useParams` instead
- The `useBase` hook has been removed
- The `useLinkResolve` hook has been renamed to `useResolve`

Expand Down Expand Up @@ -51,12 +57,14 @@

## Fixes:

- Fix incorrect resolving of links after component initialization, when using `useLinkResolve`
- Fix incorrect resolving of links after component initialization, when using
`useLinkResolve`

## Breaking:

- Remove `name` prop from `Route`. Use `meta` prop instead
- Remove the apps basepath from the location, so the location always looks the same, no matter where the app is served from
- Remove the apps basepath from the location, so the location always looks the
same, no matter where the app is served from

## Other:

Expand All @@ -67,15 +75,20 @@

# 1.1.0

- Add `name` prop to `Route`, to identify a specific `Route` for example, when using the `useActiveRoute` hook
- Always keep the `route.path` intact. Use `route.fullPath` for resolved absolute path in navigation
- Add `name` prop to `Route`, to identify a specific `Route` for example, when
using the `useActiveRoute` hook
- Always keep the `route.path` intact. Use `route.fullPath` for resolved
absolute path in navigation
- Use a unique id internally for matching, instead of object identity

# 1.0.0

- Expose scoped `navigate` function as prop of `Route` `component` and in slots with `let:navigate`
- Allow configuration of `Router` history through `history` prop, and exposition of `createHistory` and `createMemorySource` functions
- Allow passing of custom `navigate` function to `link` and `links` actions via `use:link={myCustomNavigate}`
- Expose scoped `navigate` function as prop of `Route` `component` and in slots
with `let:navigate`
- Allow configuration of `Router` history through `history` prop, and exposition
of `createHistory` and `createMemorySource` functions
- Allow passing of custom `navigate` function to `link` and `links` actions via
`use:link={myCustomNavigate}`
- Add more examples and improve documentation

# 0.4.0
Expand All @@ -92,4 +105,6 @@

- Fix link resolution

Checkout [svelte-routings Changelog](https://github.com/EmilTholin/svelte-routing/blob/master/CHANGELOG.md) for previous changes.
Checkout
[svelte-routings Changelog](https://github.com/EmilTholin/svelte-routing/blob/master/CHANGELOG.md)
for previous changes.
52 changes: 27 additions & 25 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,43 @@
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

## Scope

Expand All @@ -58,17 +58,19 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at michel.strelow97@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

Expand Down
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## Pull Requests

Please don't send pull requests for new features, open an issue, so we can discuss how we want to go forward.
Please don't send pull requests for new features, open an issue, so we can
discuss how we want to go forward.

If you're submitting a PR, make sure to add tests for your feature/fix.

Expand Down Expand Up @@ -40,9 +41,11 @@ yarn test
## Developing new examples

- Copy the setup for one of the existing examples.
- Replace all imports from "svelte-navigator" with "../../../src", if you want to edit the Routers source for debugging purposes
- Replace all imports from "svelte-navigator" with "../../../src", if you want
to edit the Routers source for debugging purposes
- Create an example and add a README for it
- Add a link to it (and if possible a link to the example running in the Svelte REPL) to the main README
- Add a link to it (and if possible a link to the example running in the Svelte
REPL) to the main README
- Change all imports back to "svelte-navigator"

```bash
Expand Down
Loading

0 comments on commit 46e1628

Please # to comment.