Skip to content

Commit

Permalink
Add links to boilerplate repos (#399)
Browse files Browse the repository at this point in the history
* Add links to boilerplate repos

* Mention 'use client'

* Add a link to the Remix repo
  • Loading branch information
RomanTsukanov authored Mar 12, 2024
1 parent 0aec382 commit 10e48d2
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/get-started-angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ As a result, you will create the following dashboard:
[View Full Code on GitHub](https://github.com/surveyjs/code-examples/tree/main/get-started-analytics/angular (linkStyle))

If you are looking for a quick-start application that includes all SurveyJS components, refer to the following GitHub repository: <a href="https://github.com/surveyjs/surveyjs_angular_cli" target="_blank">SurveyJS + Angular CLI Quickstart Template</a>.

## Install the `survey-analytics` npm Package

SurveyJS Dashboard is distributed as a <a href="https://www.npmjs.com/package/survey-analytics" target="_blank">survey-analytics</a> npm package. Run the following command to install it:
Expand Down
17 changes: 16 additions & 1 deletion docs/get-started-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ As a result, you will create the following dashboard:
[View Full Code on GitHub](https://github.com/surveyjs/code-examples/tree/main/get-started-analytics/react (linkStyle))

If you are looking for a quick-start application that includes all SurveyJS components, refer to the following GitHub repositories:

- <a href="https://github.com/surveyjs/surveyjs_react_quickstart" target="_blank">SurveyJS + React Quickstart Template</a>
- <a href="https://github.com/surveyjs/surveyjs-nextjs" target="_blank">SurveyJS + Next.js Quickstart Template</a>
- <a href="https://github.com/surveyjs/surveyjs-remix" target="_blank">SurveyJS + Remix Quickstart Template</a>

## Install the `survey-analytics` npm Package

SurveyJS Dashboard is distributed as a <a href="https://www.npmjs.com/package/survey-analytics" target="_blank">survey-analytics</a> npm package. Run the following command to install it:
Expand Down Expand Up @@ -256,9 +262,15 @@ export default function App() {

## Render the Visualization Panel

A Visualization Panel should be rendered in a page element. Add this element to the component markup:
A Visualization Panel should be rendered in a page element. Add this element to the component markup, as shown below.

> If you are using [Next.js](https://nextjs.org) or another framework that [has adopted React Server Components](https://react.dev/learn/start-a-new-react-project#bleeding-edge-react-frameworks), you need to explicitly mark the React component that renders a SurveyJS component as client code using the ['use client'](https://react.dev/reference/react/use-client) directive.
```js
// Uncomment the following line if you are using Next.js:
// 'use client'

// ...
export default function App() {
// ...
return (
Expand Down Expand Up @@ -292,6 +304,9 @@ To view the application, run `npm run start` in a command line and open [http://
<summary>View Full Code</summary>

```js
// Uncomment the following line if you are using Next.js:
// 'use client'

import { useState, useEffect } from 'react';
import 'survey-analytics/survey.analytics.min.css';
import { Model } from 'survey-core';
Expand Down
5 changes: 5 additions & 0 deletions docs/get-started-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ As a result, you will create the following dashboard:
[View Full Code on GitHub](https://github.com/surveyjs/code-examples/tree/main/get-started-analytics/vue (linkStyle))

If you are looking for a quick-start application that includes all SurveyJS components, refer to the following GitHub repositories:

- <a href="https://github.com/surveyjs/surveyjs_vue3_quickstart" target="_blank">SurveyJS + Vue 3 Quickstart Template</a>
- <a href="https://github.com/surveyjs/surveyjs_vue_quickstart" target="_blank">SurveyJS + Vue 2 Quickstart Template</a>

## Install the `survey-analytics` npm Package

SurveyJS Dashboard is distributed as a <a href="https://www.npmjs.com/package/survey-analytics" target="_blank">survey-analytics</a> npm package. Run the following command to install it:
Expand Down

0 comments on commit 10e48d2

Please sign in to comment.