Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@limetech/lime-web-components-interfaces
Advanced tools
@limetech/lime-web-components-interfaces - npm Package Compare versions
Comparing version 4.38.0 to 4.38.5
@@ -6,2 +6,10 @@ # Change Log | ||
| ## [4.38.5](https://github.com/Lundalogik/lime-web-components/compare/v4.38.4...v4.38.5) (2022-03-03) | ||
| **Note:** Version bump only for package @limetech/lime-web-components-interfaces | ||
| # [4.38.0](https://github.com/Lundalogik/lime-web-components/compare/v4.37.0...v4.38.0) (2022-02-25) | ||
@@ -8,0 +16,0 @@ |
| /** | ||
| * Service for navigating to a url. | ||
| * The {@link Navigator} service lets you navigate to a new location within the | ||
| * application, or update the current location with new data. A location is | ||
| * defined by a path and optional data. | ||
| * | ||
| * When navigating to a new location, a new entry will be pushed to the history | ||
| * stack in the browser and the {@link EventDispatcherService} will emit a | ||
| * {@link NavigationEvent}. | ||
| * | ||
| * New locations can be registered using the {@link RouteRegistry} service | ||
| * | ||
| * @example | ||
| * // Listen on navigation events | ||
| * eventDispatcher.addListener('navigate', onNavigate); | ||
| * navigator.navigate('/object/deal/1001'); | ||
| * | ||
| * function onNavigate(event: NavigationEvent) { | ||
| * console.log(event.detail); | ||
| * } | ||
| * | ||
| * @experimental | ||
@@ -8,8 +25,10 @@ */ | ||
| /** | ||
| * Navigate to a url | ||
| * Navigate to a new location | ||
| * | ||
| * @emits navigate of type {@link NavigationEvent} using the event dispatcher when navigating to the new URL. | ||
| * @param {string} url the url string | ||
| * @emits navigate - When the location has been changed the | ||
| * {@link EventDispatcherService} will emit a {@link NavigationEvent} | ||
| * | ||
| * @param {string} path path to the location | ||
| */ | ||
| navigate(url: string): void; | ||
| navigate(path: string): void; | ||
| /** | ||
@@ -24,3 +43,3 @@ * Get the current location | ||
| /** | ||
| * The pathname of the URL. | ||
| * The path to the location | ||
| */ | ||
@@ -41,2 +60,6 @@ path: string; | ||
| }; | ||
| /** | ||
| * @event navigate - Emitted when a new location is navigated to or the current | ||
| * location is updated | ||
| */ | ||
| export declare type NavigationEvent = CustomEvent<Location>; |
| /** | ||
| * Service for registering and matching routes. | ||
| * The {@link RouteRegistry} service lets you register new locations in the | ||
| * application specified by either a path or a path pattern. Once a location | ||
| * has been registered, it can be navigated to using the {@link Navigator} | ||
| * service. | ||
| * | ||
| * When registering a route, any parameters in the path will be used as props | ||
| * on the component when it is being rendered. Parameters will be of type | ||
| * `string`, when the parameter can be parsed as a number the type will instead | ||
| * be `number`. | ||
| * | ||
| * @note Special handling will be used for parameters named `limetype` and `id` | ||
| * to create a {@link LimeWebComponentContext} for the component. `id` can be | ||
| * used on it's own, but will be used to create `context` if `limetype` is also | ||
| * present. | ||
| * | ||
| * @example | ||
| * // Registering a simple route | ||
| * routeRegistry.registerRoute('/foo', 'foo-component'); | ||
| * | ||
| * @example | ||
| * // Registering a route with parameters | ||
| * // `name` will be used as a prop on the component when it renders | ||
| * routeRegistry.registerRoute('/foo/:name', 'foo-component'); | ||
| * | ||
| * @example | ||
| * // Registering a route with a context | ||
| * // The `context` prop of the component will have the values of the | ||
| * // `limetype` and `id` parameters | ||
| * routeRegistry.registerRoute('/foo/:limetype/:id', 'foo-component'); | ||
| * | ||
| * @experimental | ||
@@ -10,12 +38,14 @@ */ | ||
| * | ||
| * @param {string} pathPattern - URL pathname pattern used to match a component. | ||
| * @param {string} pathPattern - path pattern used to match a component. | ||
| * For more information about URL patterns read [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API). | ||
| * @param {string} component - The component to register to the given URL pattern. | ||
| * @param {string} component - Name of the component to register for the | ||
| * specified pattern | ||
| */ | ||
| registerRoute(pathPattern: string, component: string): void; | ||
| /** | ||
| * Find the component for a given URL. | ||
| * Find the component for a given path. | ||
| * | ||
| * @param {string} path - The pathname or the URL to match against. | ||
| * @return {MatchedComponent | undefined} Returns the component along with route parameters if found. | ||
| * @param {string} path - The path to match against. | ||
| * @return {MatchedComponent | undefined} the matched component along with | ||
| * path parameters, or `undefined` if no component could be found. | ||
| */ | ||
@@ -22,0 +52,0 @@ findComponent(path: string): MatchedComponent | undefined; |
| { | ||
| "name": "@limetech/lime-web-components-interfaces", | ||
| "version": "4.38.0", | ||
| "version": "4.38.5", | ||
| "author": "Lime Technologies", | ||
@@ -33,3 +33,3 @@ "homepage": "https://github.com/Lundalogik/lime-web-components", | ||
| }, | ||
| "gitHead": "ea1bb721b47bc67548b837600f49c6caa8f4dfa0" | ||
| "gitHead": "30a6854bc8eb7f91114dcfc948ff8a87d3b78bfb" | ||
| } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.85%
82013
- Lines of code
- increased by2.88%
1891
No dependency changes