API JavaScript dành cho Office cho phép bạn tạo các ứng dụng web tương tác với các mô hình đối tượng trong các ứng dụng máy chủ Office. Ứng dụng của bạn sẽ tham khảo văn phòng. thư viện js, là trình tải tập lệnh. Văn phòng. thư viện js tải các mô hình đối tượng áp dụng cho ứng dụng Office đang chạy phần bổ trợ
Giới thiệu về gói NPM
Gói NPM cho Office. js là bản sao của những gì được xuất bản lên Văn phòng "thường xanh" chính thức. js CDN, tại https. //ứng dụng cho văn phòng. Microsoft. com/lib/1/được lưu trữ/văn phòng. js
Văn phòng. js CDN chứa tất cả Office hiện có. js API bất cứ lúc nào
Mỗi văn phòng. js gói NPM chỉ chứa Office. js có sẵn trên Office. js CDN khi phiên bản gói NPM được tạo
Kịch bản mục tiêu
Gói NPM cho Office. js nhằm mục đích lấy bản sao ngoại tuyến [không phải CDN] của Office. js, sau đó có thể phân phối tĩnh từ trang web của bạn thay vì sử dụng CDN
Gói NPM này được cung cấp cho các tình huống sau
- Phát triển phần bổ trợ phía sau tường lửa, khi truy cập Office. js CDN là không thể
- Truy cập ngoại tuyến vào Office. js để hỗ trợ gỡ lỗi ngoại tuyến
Quan trọng. Phần bổ trợ Office được xuất bản lên AppSource phải sử dụng tham chiếu CDN. Văn phòng ngoại tuyến. js chỉ thích hợp cho các kịch bản phát triển nội bộ và gỡ lỗi
Thực hành tốt nhất
Các phương pháp hay nhất để sử dụng Office. gói NPM js bao gồm
Làm mới gói NPM định kỳ để truy cập các API mới và sửa lỗi
Không nhập gói NPM như thường làm với các gói NPM khác
Không sử dụng gói NPM trong Bổ trợ dành cho xuất bản lên AppSource. Phần bổ trợ được xuất bản lên AppSource phải sử dụng Office. js CDN
.
Ủng hộ
Văn phòng. js CDN là nguồn được hỗ trợ chính thức cho Phần bổ trợ Office
Đối với gói NPM được lấy từ kho lưu trữ này, chỉ hỗ trợ phiên bản mới nhất của gói. Không hỗ trợ và không có bản vá nào được cung cấp cho các phiên bản trước của gói. Tần suất cập nhật cho kho lưu trữ này và gói NPM có liên quan để phù hợp với phiên bản CDN không được đảm bảo
Bổ trợ Outlook không hỗ trợ lưu trữ Office. js ngoại tuyến do yêu cầu truy cập mạng đối với các phần phụ thuộc như thư viện Microsoft Ajax
Cài đặt gói NPM
Để cài đặt cục bộ "office-js" thông qua gói NPM, hãy chạy lệnh sau
cài đặt npm @microsoft/office-js --save
Chính sách của chúng tôi yêu cầu các nhà phát triển luôn tham khảo phiên bản Office mới nhất. thư viện js. Điều này nhằm đảm bảo rằng các bản cập nhật sản phẩm thiết yếu được cung cấp nhanh chóng cho Phần bổ trợ Office bằng cách luôn tham chiếu bản phát hành mới nhất của thư viện cho một phiên bản nhất định, chẳng hạn như phiên bản Thường có sẵn [GA]. Cho rằng Office mới nhất. js tương thích ngược với các bản phát hành trước, việc cập nhật lên bản phát hành mới nhất của thư viện là an toàn khi có sẵn. Do đó, chỉ có phiên bản mới nhất của Office. js gói NPM được cung cấp để cài đặt
Sử dụng gói NPM
Cài đặt gói NPM cục bộ sẽ tạo một bộ Office tĩnh. js trong thư mục node_modules\@microsoft\office-js\dist
của thư mục mà bạn đã chạy lệnh npm install
. Để sử dụng gói NPM, hãy làm như sau
Theo cách thủ công hoặc là một phần của tập lệnh xây dựng [e. g. ,
CopyWebpackPlugin
nếu bạn đang sử dụng Webpack] có các tệp được cung cấp từ đích bạn chọn [e. g. , từ thư mục/assets/office-js/
của máy chủ web của bạn]Tham chiếu vị trí đó trong thẻ
trong tệp HTML trong dự án bổ trợ của bạn
Ví dụ: nếu bạn thêm nội dung của thư mục dist
vào thư mục assets/office-js
của dự án, thì bạn sẽ thêm thẻ sau vào tệp HTML của mình
định nghĩa IntelliSense
Định nghĩa TypeScript cho Office. js có sẵn
- phiên bản PHÁT HÀNH mới nhất của Office. js
- chắc chắn gõ. https. //github. com/DefinitelyTyped/DefinitelyTyped/blob/master/types/office-js/index. d. ts
- @loại.
@types/office-js
cài đặt npm @types/office-js --save-dev
- phiên bản BETA mới nhất của Office. js
- chắc chắn gõ. https. //github. com/DefinitelyTyped/DefinitelyTyped/blob/master/types/office-js-preview/index. d. ts
- @loại.
node_modules\@microsoft\office-js\dist
0
cài đặt npm @types/office-js-preview --save-dev
- bất kỳ phiên bản
- Bên trong gói NPM, bên dưới
node_modules\@microsoft\office-js\dist
1 - Trong repo này. văn phòng quận. d. ts
- Bên trong gói NPM, bên dưới
Sử dụng các định nghĩa TypeScript với gói NPM
Nếu bạn đang sử dụng Office. js NPM cho và muốn có một d. ts khớp chính xác với nội dung JS, hãy sử dụng d. ts nằm trong thư mục node_modules\@microsoft\office-js\dist
2 của gói NPM. Đạt được điều này bằng cách sử dụng tham chiếu ba dấu gạch chéo
- TIỀN BOA. Nếu bạn tạo một tệp
node_modules\@microsoft\office-js\dist
3 ở thư mục gốc của dự án, chỉ cần trỏ tham chiếu tớinode_modules\@microsoft\office-js\dist
4 ở đó
Nếu bạn không cần , đừng sử dụng Office. js NPM, lấy các định nghĩa TypeScript bằng cách sử dụng @types/office-js
và tham khảo Office. js CDN tại https. //ứng dụng cho văn phòng. Microsoft. com/lib/1/được lưu trữ/văn phòng. js
Kích hoạt IntelliSense trong Visual Studio
Visual Studio 2017+ có thể sử dụng cùng các định nghĩa TypeScript này, ngay cả đối với JavaScript thông thường. Đối với JavaScript IntelliSense trong các phiên bản cũ hơn của Visual Studio, một tệp node_modules\@microsoft\office-js\dist
6 có sẵn cùng với tệp node_modules\@microsoft\office-js\dist
7. Miễn là bạn có tệp node_modules\@microsoft\office-js\dist
8 trong dự án VS của mình và miễn là bạn thay thế tham chiếu dấu gạch chéo ba hiện có [node_modules\@microsoft\office-js\dist
9] bằng vị trí mới [phần npm install
0 được thay thế tự động, vì vậy hãy sử dụng nó giống như cách bạn làm trong npm install
1
Phiên bản gói NPM
Văn phòng. phiên bản js được mô tả chi tiết trong https. // tài liệu. Microsoft. com/office/dev/add-ins/develop/referencing-the-javascript-api-for-office-library-from-its-cdn. Điều quan trọng là có sự khác biệt giữa nội dung trong tệp JS so với khả năng của một máy tính cụ thể [tôi. e. , các phiên bản office cũ hơn hoặc cập nhật chậm hơn]
Gói NPM và các nhánh repo có cấu trúc như sau
Tên chi nhánh GitHub Tên thẻ NPM Mô tả_______2_______2npm install
3Giống với bản phát hành trước trên https. //ứng dụng cho văn phòng. Microsoft. com/lib/1/được lưu trữ/văn phòng. jsCác API công khai được phát hành mới nhất.
npm install
4_______2_______4Giống với bản phát hành trước trên https. //ứng dụng cho văn phòng. Microsoft. com/lib/beta/được lưu trữ/văn phòng. jsCác API sắp ra mắt, không nhất thiết phải sẵn sàng để sử dụng chung mà có thể thay đổi. Có thể khả dụng trên các bản dựng Người dùng nội bộ nhanh [và có thể là Người dùng nội bộ chậm]
quy tắc ứng xử
Dự án này đã áp dụng Bộ quy tắc ứng xử mã nguồn mở của Microsoft. Để biết thêm thông tin, hãy xem Câu hỏi thường gặp về Quy tắc Ứng xử hoặc liên hệ với opencode@microsoft. com với bất kỳ câu hỏi hoặc ý kiến thêm
Thêm thông tin
Để biết thêm thông tin về Phần bổ trợ Office và API JavaScript của Office, hãy xem
- Tổng quan về nền tảng Phần bổ trợ Office
- API JavaScript để tham khảo Office
Tham gia Chương trình dành cho nhà phát triển Microsoft 365
Nhận hộp cát miễn phí, công cụ và các tài nguyên khác mà bạn cần để xây dựng giải pháp cho nền tảng Microsoft 365