Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
72 changes: 42 additions & 30 deletions packages/docs/src/routes/api/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { $, component$, useOn, useSignal, useStore, useTask$, isBrowser } from '@builder.io/qwik';
import { Link } from '@builder.io/qwik-city';

import { toSnakeCase } from '../../utils/utils';

// TODO: load the content of these files using fs instead of importing them
Expand Down Expand Up @@ -140,32 +139,45 @@ export const ApiMemberWrapper = component$(({ id, data, filters }: any) => {
});


export const ApiMemberList = component$(({ id, data, filters }: any) => (
<ul class="grid sm:grid-cols-2 lg:grid-cols-3 pb-5">
{data.members.map((member: any) => {
const kind = toSnakeCase(member.kind);

if (!member.name) {
return;
}

const name = member.name.toLowerCase()
.replace(/[^a-zA-Z0-9]/g, '')
.replace(/ /g, '-');


return (
<li
key={`${id}-member-${member.id}-${kind}`}
data-kind={kind}
data-kind-label={kind.substring(0, 1).toUpperCase()}
class={`api-item list-none text-xs ${
(kind in filters && !filters[kind] && 'hidden') || ''
}`}
>
<Link href={`${data.id}#${name}`}>{member.name}</Link>
</li>
);
})}
</ul>
));
export const ApiMemberList = component$(({ id, data, filters }: any) => {
const nameCounts = data.members.reduce((acc: Record<string, number>, m: any) => {
if (m.name) {
const normalizedName = m.name.toLowerCase();
acc[normalizedName] = (acc[normalizedName] || 0) + 1;
}
return acc;
}, {});
return (
<ul class="grid sm:grid-cols-2 lg:grid-cols-3 pb-5">
{data.members.map((member: any) => {
const kind = toSnakeCase(member.kind);

if (!member.name) {
return;
}

const name = member.name.toLowerCase()
.replace(/[$]/g, '_')
.replace(/[^a-zA-Z0-9_]/g, '')
.replace(/ /g, '-');

const anchorId = nameCounts[member.name.toLowerCase()] > 1
? `${name}-${kind}`
: name;

return (
<li
key={`${id}-member-${member.id}-${kind}`}
data-kind={kind}
data-kind-label={kind.substring(0, 1).toUpperCase()}
class={`api-item list-none text-xs ${
(kind in filters && !filters[kind] && 'hidden') || ''
}`}
>
<Link href={`${data.id}#${anchorId}`}>{member.name}</Link>
</li>
);
})}
</ul>
);
});
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/aws-lambda API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/aws-lambda

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(opts: AwsOpt): {
Expand Down Expand Up @@ -60,7 +60,7 @@ AwsOpt

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/aws-lambda/index.ts)

## PlatformAwsLambda
<h2 id="platformawslambda">PlatformAwsLambda</h2>

```typescript
export interface PlatformAwsLambda extends Object
Expand All @@ -70,7 +70,7 @@ export interface PlatformAwsLambda extends Object

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/aws-lambda/index.ts)

## QwikCityAwsLambdaOptions
<h2 id="qwikcityawslambdaoptions">QwikCityAwsLambdaOptions</h2>

```typescript
export interface QwikCityAwsLambdaOptions extends ServerRenderOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/azure-swa API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/azure-swa

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(
Expand Down Expand Up @@ -44,7 +44,7 @@ AzureFunction

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/azure-swa/index.ts)

## PlatformAzure
<h2 id="platformazure">PlatformAzure</h2>

```typescript
export interface PlatformAzure extends Partial<Context>
Expand All @@ -54,7 +54,7 @@ export interface PlatformAzure extends Partial<Context>

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/azure-swa/index.ts)

## QwikCityAzureOptions
<h2 id="qwikcityazureoptions">QwikCityAzureOptions</h2>

```typescript
export interface QwikCityAzureOptions extends ServerRenderOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/cloudflare-pages API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/cloudflare-pages

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(opts: QwikCityCloudflarePagesOptions): (
Expand Down Expand Up @@ -50,7 +50,7 @@ opts

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/cloudflare-pages/index.ts)

## PlatformCloudflarePages
<h2 id="platformcloudflarepages">PlatformCloudflarePages</h2>

```typescript
export interface PlatformCloudflarePages
Expand Down Expand Up @@ -118,7 +118,7 @@ Request

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/cloudflare-pages/index.ts)

## QwikCityCloudflarePagesOptions
<h2 id="qwikcitycloudflarepagesoptions">QwikCityCloudflarePagesOptions</h2>

```typescript
export interface QwikCityCloudflarePagesOptions extends ServerRenderOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/firebase API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/firebase

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(
Expand Down Expand Up @@ -44,7 +44,7 @@ opts

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/firebase/index.ts)

## PlatformFirebase
<h2 id="platformfirebase">PlatformFirebase</h2>

```typescript
export interface PlatformFirebase extends Object
Expand All @@ -54,7 +54,7 @@ export interface PlatformFirebase extends Object
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/firebase/index.ts)
## QwikCityFirebaseOptions
<h2 id="qwikcityfirebaseoptions">QwikCityFirebaseOptions</h2>
```typescript
export interface QwikCityFirebaseOptions extends ServerRenderOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/netlify-edge API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/netlify-edge

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(
Expand Down Expand Up @@ -44,7 +44,7 @@ opts

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/netlify-edge/index.ts)

## PlatformNetlify
<h2 id="platformnetlify">PlatformNetlify</h2>

```typescript
export interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies'>>
Expand All @@ -54,7 +54,7 @@ export interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/netlify-edge/index.ts)

## QwikCityNetlifyOptions
<h2 id="qwikcitynetlifyoptions">QwikCityNetlifyOptions</h2>

```typescript
export interface QwikCityNetlifyOptions extends ServerRenderOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: \@builder.io/qwik-city/middleware/node API Reference

# [API](/api) &rsaquo; @builder.io/qwik-city/middleware/node

## createQwikCity
<h2 id="createqwikcity">createQwikCity</h2>

```typescript
export declare function createQwikCity(opts: QwikCityNodeRequestOptions): {
Expand Down Expand Up @@ -58,15 +58,15 @@ opts

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)

## NodeRequestNextFunction
<h2 id="noderequestnextfunction">NodeRequestNextFunction</h2>

```typescript
export interface NodeRequestNextFunction
```

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)

## PlatformNode
<h2 id="platformnode">PlatformNode</h2>

```typescript
export interface PlatformNode
Expand Down Expand Up @@ -138,7 +138,7 @@ _(Optional)_

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/src/middleware/node/index.ts)

## QwikCityNodeRequestOptions
<h2 id="qwikcitynoderequestoptions">QwikCityNodeRequestOptions</h2>

```typescript
export interface QwikCityNodeRequestOptions extends ServerRenderOptions
Expand Down
Loading